java.lang.Objectcom.aspose.words.FootnoteOptions
public class FootnoteOptions
Example: Example:
Document doc = new Document(getMyDir() + "Footnotes and endnotes.docx");
// Let's change number of columns for footnotes on page. If columns value is 0 than footnotes area
// is formatted with a number of columns based on the number of columns on the displayed page
doc.getFootnoteOptions().setColumns(2);
doc.save(getArtifactsDir() + "Document.FootnoteColumns.docx");
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert 3 paragraphs with a footnote at the end of each one
builder.write("Text 1. ");
builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 1");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.write("Text 2. ");
builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 2");
builder.write("Text 3. ");
builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 3", "Custom reference mark");
// Edit the numbering and positioning of footnotes
doc.getFootnoteOptions().setPosition(FootnotePosition.BENEATH_TEXT);
doc.getFootnoteOptions().setNumberStyle(NumberStyle.UPPERCASE_ROMAN);
doc.getFootnoteOptions().setRestartRule(FootnoteNumberingRule.CONTINUOUS);
doc.getFootnoteOptions().setStartNumber(1);
doc.save(getArtifactsDir() + "Document.Footnotes.docx");
Property Getters/Setters Summary | ||
---|---|---|
int | getColumns() | |
void | setColumns(int value) | |
Specifies the number of columns with which the footnotes area is formatted. | ||
int | getNumberStyle() | |
void | setNumberStyle(int value) | |
Specifies the number format for automatically numbered footnotes. The value of the property is NumberStyle integer constant. | ||
int | getPosition() | |
void | setPosition(int value) | |
Specifies the footnotes position. The value of the property is FootnotePosition integer constant. | ||
int | getRestartRule() | |
void | setRestartRule(int value) | |
Determines when automatic numbering restarts. The value of the property is FootnoteNumberingRule integer constant. | ||
int | getStartNumber() | |
void | setStartNumber(int value) | |
Specifies the starting number or character for the first automatically numbered footnotes. |
Property Getters/Setters Detail |
---|
getColumns/setColumns | |
public int getColumns() / public void setColumns(int value) |
Example:
Shows how to set the number of columns with which the footnotes area is formatted.Document doc = new Document(getMyDir() + "Footnotes and endnotes.docx"); // Let's change number of columns for footnotes on page. If columns value is 0 than footnotes area // is formatted with a number of columns based on the number of columns on the displayed page doc.getFootnoteOptions().setColumns(2); doc.save(getArtifactsDir() + "Document.FootnoteColumns.docx");
getNumberStyle/setNumberStyle | |
public int getNumberStyle() / public void setNumberStyle(int value) |
Not all number styles are applicable for this property. For the list of applicable number styles see the Insert Footnote or Endnote dialog box in Microsoft Word. If you select a number style that is not applicable, Microsoft Word will revert to a default value.
Example:
Shows how to insert footnotes and edit their appearance.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert 3 paragraphs with a footnote at the end of each one builder.write("Text 1. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 1"); builder.insertBreak(BreakType.PAGE_BREAK); builder.write("Text 2. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 2"); builder.write("Text 3. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 3", "Custom reference mark"); // Edit the numbering and positioning of footnotes doc.getFootnoteOptions().setPosition(FootnotePosition.BENEATH_TEXT); doc.getFootnoteOptions().setNumberStyle(NumberStyle.UPPERCASE_ROMAN); doc.getFootnoteOptions().setRestartRule(FootnoteNumberingRule.CONTINUOUS); doc.getFootnoteOptions().setStartNumber(1); doc.save(getArtifactsDir() + "Document.Footnotes.docx");
getPosition/setPosition | |
public int getPosition() / public void setPosition(int value) |
Example:
Shows how to insert footnotes and edit their appearance.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert 3 paragraphs with a footnote at the end of each one builder.write("Text 1. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 1"); builder.insertBreak(BreakType.PAGE_BREAK); builder.write("Text 2. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 2"); builder.write("Text 3. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 3", "Custom reference mark"); // Edit the numbering and positioning of footnotes doc.getFootnoteOptions().setPosition(FootnotePosition.BENEATH_TEXT); doc.getFootnoteOptions().setNumberStyle(NumberStyle.UPPERCASE_ROMAN); doc.getFootnoteOptions().setRestartRule(FootnoteNumberingRule.CONTINUOUS); doc.getFootnoteOptions().setStartNumber(1); doc.save(getArtifactsDir() + "Document.Footnotes.docx");
getRestartRule/setRestartRule | |
public int getRestartRule() / public void setRestartRule(int value) |
Example:
Shows how to insert footnotes and edit their appearance.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert 3 paragraphs with a footnote at the end of each one builder.write("Text 1. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 1"); builder.insertBreak(BreakType.PAGE_BREAK); builder.write("Text 2. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 2"); builder.write("Text 3. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 3", "Custom reference mark"); // Edit the numbering and positioning of footnotes doc.getFootnoteOptions().setPosition(FootnotePosition.BENEATH_TEXT); doc.getFootnoteOptions().setNumberStyle(NumberStyle.UPPERCASE_ROMAN); doc.getFootnoteOptions().setRestartRule(FootnoteNumberingRule.CONTINUOUS); doc.getFootnoteOptions().setStartNumber(1); doc.save(getArtifactsDir() + "Document.Footnotes.docx");
getStartNumber/setStartNumber | |
public int getStartNumber() / public void setStartNumber(int value) |
This property has effect only when
Example:
Shows how to insert footnotes and edit their appearance.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert 3 paragraphs with a footnote at the end of each one builder.write("Text 1. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 1"); builder.insertBreak(BreakType.PAGE_BREAK); builder.write("Text 2. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 2"); builder.write("Text 3. "); builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 3", "Custom reference mark"); // Edit the numbering and positioning of footnotes doc.getFootnoteOptions().setPosition(FootnotePosition.BENEATH_TEXT); doc.getFootnoteOptions().setNumberStyle(NumberStyle.UPPERCASE_ROMAN); doc.getFootnoteOptions().setRestartRule(FootnoteNumberingRule.CONTINUOUS); doc.getFootnoteOptions().setStartNumber(1); doc.save(getArtifactsDir() + "Document.Footnotes.docx");