public class FieldStyleRef extends Field
To learn more, visit the Working with Fields documentation article.
Remarks:
The STYLEREF is used to reference a fragment of text within the document that is formatted with the specified style.
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
| Modifier and Type | Method and Description |
|---|---|
boolean |
getInsertParagraphNumber()
Gets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
|
boolean |
getInsertParagraphNumberInFullContext()
Gets whether to insert the paragraph number of the referenced paragraph in full context.
|
boolean |
getInsertParagraphNumberInRelativeContext()
Gets whether to insert the paragraph number of the referenced paragraph in relative context.
|
boolean |
getInsertRelativePosition()
Gets whether to insert the relative position of the referenced paragraph.
|
boolean |
getSearchFromBottom()
Gets whether to search from the bottom of the current page, rather from the top.
|
java.lang.String |
getStyleName()
Gets the name of the style by which the text to search for is formatted.
|
boolean |
getSuppressNonDelimiters()
Gets whether to suppress non-delimiter characters.
|
int |
getSwitchType(java.lang.String switchName) |
void |
setInsertParagraphNumber(boolean value)
Sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
|
void |
setInsertParagraphNumberInFullContext(boolean value)
Sets whether to insert the paragraph number of the referenced paragraph in full context.
|
void |
setInsertParagraphNumberInRelativeContext(boolean value)
Sets whether to insert the paragraph number of the referenced paragraph in relative context.
|
void |
setInsertRelativePosition(boolean value)
Sets whether to insert the relative position of the referenced paragraph.
|
void |
setSearchFromBottom(boolean value)
Sets whether to search from the bottom of the current page, rather from the top.
|
void |
setStyleName(java.lang.String value)
Sets the name of the style by which the text to search for is formatted.
|
void |
setSuppressNonDelimiters(boolean value)
Sets whether to suppress non-delimiter characters.
|
getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, updatepublic int getSwitchType(java.lang.String switchName)
public java.lang.String getStyleName()
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
public void setStyleName(java.lang.String value)
throws java.lang.Exception
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
value - The name of the style by which the text to search for is formatted.java.lang.Exceptionpublic boolean getSearchFromBottom()
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
public void setSearchFromBottom(boolean value)
throws java.lang.Exception
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
value - Whether to search from the bottom of the current page, rather from the top.java.lang.Exceptionpublic boolean getInsertParagraphNumber()
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
public void setInsertParagraphNumber(boolean value)
throws java.lang.Exception
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
value - Whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.java.lang.Exceptionpublic boolean getInsertRelativePosition()
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
public void setInsertRelativePosition(boolean value)
throws java.lang.Exception
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
value - Whether to insert the relative position of the referenced paragraph.java.lang.Exceptionpublic boolean getInsertParagraphNumberInRelativeContext()
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
public void setInsertParagraphNumberInRelativeContext(boolean value)
throws java.lang.Exception
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
value - Whether to insert the paragraph number of the referenced paragraph in relative context.java.lang.Exceptionpublic boolean getSuppressNonDelimiters()
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
public void setSuppressNonDelimiters(boolean value)
throws java.lang.Exception
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
value - Whether to suppress non-delimiter characters.java.lang.Exceptionpublic boolean getInsertParagraphNumberInFullContext()
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
public void setInsertParagraphNumberInFullContext(boolean value)
throws java.lang.Exception
Examples:
Shows how to use STYLEREF fields.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a list based using a Microsoft Word list template.
List list = doc.getLists().add(com.aspose.words.ListTemplate.NUMBER_DEFAULT);
// This generated list will display "1.a )".
// Space before the bracket is a non-delimiter character, which we can suppress.
list.getListLevels().get(0).setNumberFormat(" .");
list.getListLevels().get(1).setNumberFormat(" )");
// Add text and apply paragraph styles that STYLEREF fields will reference.
builder.getListFormat().setList(list);
builder.getListFormat().listIndent();
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 1");
builder.getParagraphFormat().setStyle(doc.getStyles().get("Quote"));
builder.writeln("Item 2");
builder.getParagraphFormat().setStyle(doc.getStyles().get("List Paragraph"));
builder.writeln("Item 3");
builder.getListFormat().removeNumbers();
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
// Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
FieldStyleRef field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
// Place a STYLEREF field in the footer, and have it display the last text.
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("List Paragraph");
field.setSearchFromBottom(true);
builder.moveToDocumentEnd();
// We can also use STYLEREF fields to reference the list numbers of lists.
builder.write("\nParagraph number: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumber(true);
builder.write("\nParagraph number, relative context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInRelativeContext(true);
builder.write("\nParagraph number, full context: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
builder.write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef) builder.insertField(FieldType.FIELD_STYLE_REF, true);
field.setStyleName("Quote");
field.setInsertParagraphNumberInFullContext(true);
field.setSuppressNonDelimiters(true);
doc.updatePageLayout();
doc.updateFields();
doc.save(getArtifactsDir() + "Field.STYLEREF.docx");
value - Whether to insert the paragraph number of the referenced paragraph in full context.java.lang.Exception