ListLabel

Inheritance: java.lang.Object

public class ListLabel

Defines properties specific to a list label.

To learn more, visit the Working with Lists documentation article.

Examples:

Shows how to extract the list labels of all paragraphs that are list items.


 Document doc = new Document(getMyDir() + "Rendering.docx");
 doc.updateListLabels();
 int listParaCount = 1;

 for (Paragraph paragraph : (Iterable) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
     // Find if we have the paragraph list. In our document, our list uses plain Arabic numbers,
     // which start at three and ends at six.
     if (paragraph.getListFormat().isListItem()) {
         System.out.println(MessageFormat.format("List item paragraph #{0}", listParaCount));

         // This is the text we get when getting when we output this node to text format.
         // This text output will omit list labels. Trim any paragraph formatting characters.
         String paragraphText = paragraph.toString(SaveFormat.TEXT).trim();
         System.out.println("Exported Text: " + paragraphText);

         ListLabel label = paragraph.getListLabel();

         // This gets the position of the paragraph in the current level of the list. If we have a list with multiple levels,
         // this will tell us what position it is on that level.
         System.out.println("\tNumerical Id: {label.LabelValue}");

         // Combine them together to include the list label with the text in the output.
         System.out.println("\tList label combined with text: {label.LabelString} {paragraphText}");
     }

 }

Methods

Method	Description
clearRunAttrs()
fetchInheritedRunAttr(int key)
getDirectRunAttr(int key)
getDirectRunAttr(int key, int revisionsView)
getFont()	Gets the list label font.
getLabelString()	Gets a string representation of list label.
getLabelValue()	Gets a numeric value for this label.
removeRunAttr(int key)
setRunAttr(int key, Object value)

clearRunAttrs()

public void clearRunAttrs()

fetchInheritedRunAttr(int key)

public Object fetchInheritedRunAttr(int key)

Parameters:

Parameter	Type	Description
key	int

Returns: java.lang.Object

getDirectRunAttr(int key)

public Object getDirectRunAttr(int key)

Parameters:

Parameter	Type	Description
key	int

Returns: java.lang.Object

getDirectRunAttr(int key, int revisionsView)

public Object getDirectRunAttr(int key, int revisionsView)

Parameters:

Parameter	Type	Description
key	int
revisionsView	int

Returns: java.lang.Object

getFont()

public Font getFont()

Gets the list label font.

Returns: Font - The list label font.

getLabelString()

public String getLabelString()

Gets a string representation of list label.

Examples:

Shows how to extract the list labels of all paragraphs that are list items.


 Document doc = new Document(getMyDir() + "Rendering.docx");
 doc.updateListLabels();
 int listParaCount = 1;

 for (Paragraph paragraph : (Iterable) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
     // Find if we have the paragraph list. In our document, our list uses plain Arabic numbers,
     // which start at three and ends at six.
     if (paragraph.getListFormat().isListItem()) {
         System.out.println(MessageFormat.format("List item paragraph #{0}", listParaCount));

         // This is the text we get when getting when we output this node to text format.
         // This text output will omit list labels. Trim any paragraph formatting characters.
         String paragraphText = paragraph.toString(SaveFormat.TEXT).trim();
         System.out.println("Exported Text: " + paragraphText);

         ListLabel label = paragraph.getListLabel();

         // This gets the position of the paragraph in the current level of the list. If we have a list with multiple levels,
         // this will tell us what position it is on that level.
         System.out.println("\tNumerical Id: {label.LabelValue}");

         // Combine them together to include the list label with the text in the output.
         System.out.println("\tList label combined with text: {label.LabelString} {paragraphText}");
     }

 }

Returns: java.lang.String - A string representation of list label.

getLabelValue()

public int getLabelValue()

Gets a numeric value for this label.

Remarks:

Use the Document.updateListLabels() method to update the value of this property.

Examples:

Shows how to extract the list labels of all paragraphs that are list items.


 Document doc = new Document(getMyDir() + "Rendering.docx");
 doc.updateListLabels();
 int listParaCount = 1;

 for (Paragraph paragraph : (Iterable) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
     // Find if we have the paragraph list. In our document, our list uses plain Arabic numbers,
     // which start at three and ends at six.
     if (paragraph.getListFormat().isListItem()) {
         System.out.println(MessageFormat.format("List item paragraph #{0}", listParaCount));

         // This is the text we get when getting when we output this node to text format.
         // This text output will omit list labels. Trim any paragraph formatting characters.
         String paragraphText = paragraph.toString(SaveFormat.TEXT).trim();
         System.out.println("Exported Text: " + paragraphText);

         ListLabel label = paragraph.getListLabel();

         // This gets the position of the paragraph in the current level of the list. If we have a list with multiple levels,
         // this will tell us what position it is on that level.
         System.out.println("\tNumerical Id: {label.LabelValue}");

         // Combine them together to include the list label with the text in the output.
         System.out.println("\tList label combined with text: {label.LabelString} {paragraphText}");
     }

 }

Returns: int - A numeric value for this label.

removeRunAttr(int key)

public void removeRunAttr(int key)

Parameters:

Parameter	Type	Description
key	int

setRunAttr(int key, Object value)

public void setRunAttr(int key, Object value)

Parameters:

Parameter	Type	Description
key	int
value	java.lang.Object

ListFormat ListLevel