## FootnoteOptions class Represents the footnote numbering options for a document or section. To learn more, visit the [Working with Footnote and Endnote](https://docs.aspose.com/words/net/working-with-footnote-and-endnote/) documentation article. ```csharp public sealed class FootnoteOptions ``` ## Properties | Name | Description | | --- | --- | | [Columns](../../aspose.words.notes/footnoteoptions/columns/) { get; set; } | Specifies the number of columns with which the footnotes area is formatted. | | [NumberStyle](../../aspose.words.notes/footnoteoptions/numberstyle/) { get; set; } | Specifies the number format for automatically numbered footnotes. | | [Position](../../aspose.words.notes/footnoteoptions/position/) { get; set; } | Specifies the footnotes position. | | [RestartRule](../../aspose.words.notes/footnoteoptions/restartrule/) { get; set; } | Determines when automatic numbering restarts. | | [StartNumber](../../aspose.words.notes/footnoteoptions/startnumber/) { get; set; } | Specifies the starting number or character for the first automatically numbered footnotes. | ## Examples Shows how to split the footnote section into a given number of columns. ```csharp Document doc = new Document(MyDir + "Footnotes and endnotes.docx"); doc.FootnoteOptions.Columns = 2; doc.Save(ArtifactsDir + "Document.FootnoteColumns.docx"); ``` Shows how to select a different place where the document collects and displays its footnotes. ```csharp Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // A footnote is a way to attach a reference or a side comment to text // that does not interfere with the main body text's flow. // Inserting a footnote adds a small superscript reference symbol // at the main body text where we insert the footnote. // Each footnote also creates an entry at the bottom of the page, consisting of a symbol // that matches the reference symbol in the main body text. // The reference text that we pass to the document builder's "InsertFootnote" method. builder.Write("Hello world!"); builder.InsertFootnote(FootnoteType.Footnote, "Footnote contents."); // We can use the "Position" property to determine where the document will place all its footnotes. // If we set the value of the "Position" property to "FootnotePosition.BottomOfPage", // every footnote will show up at the bottom of the page that contains its reference mark. This is the default value. // If we set the value of the "Position" property to "FootnotePosition.BeneathText", // every footnote will show up at the end of the page's text that contains its reference mark. doc.FootnoteOptions.Position = footnotePosition; doc.Save(ArtifactsDir + "InlineStory.PositionFootnote.docx"); ``` Shows how to change the number style of footnote/endnote reference marks. ```csharp Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Footnotes and endnotes are a way to attach a reference or a side comment to text // that does not interfere with the main body text's flow. // Inserting a footnote/endnote adds a small superscript reference symbol // at the main body text where we insert the footnote/endnote. // Each footnote/endnote also creates an entry, which consists of a symbol that matches the reference // symbol in the main body text. The reference text that we pass to the document builder's "InsertEndnote" method. // Footnote entries, by default, show up at the bottom of each page that contains // their reference symbols, and endnotes show up at the end of the document. builder.Write("Text 1. "); builder.InsertFootnote(FootnoteType.Footnote, "Footnote 1."); builder.Write("Text 2. "); builder.InsertFootnote(FootnoteType.Footnote, "Footnote 2."); builder.Write("Text 3. "); builder.InsertFootnote(FootnoteType.Footnote, "Footnote 3.", "Custom footnote reference mark"); builder.InsertParagraph(); builder.Write("Text 1. "); builder.InsertFootnote(FootnoteType.Endnote, "Endnote 1."); builder.Write("Text 2. "); builder.InsertFootnote(FootnoteType.Endnote, "Endnote 2."); builder.Write("Text 3. "); builder.InsertFootnote(FootnoteType.Endnote, "Endnote 3.", "Custom endnote reference mark"); // By default, the reference symbol for each footnote and endnote is its index // among all the document's footnotes/endnotes. Each document maintains separate counts // for footnotes and for endnotes. By default, footnotes display their numbers using Arabic numerals, // and endnotes display their numbers in lowercase Roman numerals. Assert.That(doc.FootnoteOptions.NumberStyle, Is.EqualTo(NumberStyle.Arabic)); Assert.That(doc.EndnoteOptions.NumberStyle, Is.EqualTo(NumberStyle.LowercaseRoman)); // We can use the "NumberStyle" property to apply custom numbering styles to footnotes and endnotes. // This will not affect footnotes/endnotes with custom reference marks. doc.FootnoteOptions.NumberStyle = NumberStyle.UppercaseRoman; doc.EndnoteOptions.NumberStyle = NumberStyle.UppercaseLetter; doc.Save(ArtifactsDir + "InlineStory.RefMarkNumberStyle.docx"); ``` Shows how to restart footnote/endnote numbering at certain places in the document. ```csharp Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Footnotes and endnotes are a way to attach a reference or a side comment to text // that does not interfere with the main body text's flow. // Inserting a footnote/endnote adds a small superscript reference symbol // at the main body text where we insert the footnote/endnote. // Each footnote/endnote also creates an entry, which consists of a symbol that matches the reference // symbol in the main body text. The reference text that we pass to the document builder's "InsertEndnote" method. // Footnote entries, by default, show up at the bottom of each page that contains // their reference symbols, and endnotes show up at the end of the document. builder.Write("Text 1. "); builder.InsertFootnote(FootnoteType.Footnote, "Footnote 1."); builder.Write("Text 2. "); builder.InsertFootnote(FootnoteType.Footnote, "Footnote 2."); builder.InsertBreak(BreakType.PageBreak); builder.Write("Text 3. "); builder.InsertFootnote(FootnoteType.Footnote, "Footnote 3."); builder.Write("Text 4. "); builder.InsertFootnote(FootnoteType.Footnote, "Footnote 4."); builder.InsertBreak(BreakType.PageBreak); builder.Write("Text 1. "); builder.InsertFootnote(FootnoteType.Endnote, "Endnote 1."); builder.Write("Text 2. "); builder.InsertFootnote(FootnoteType.Endnote, "Endnote 2."); builder.InsertBreak(BreakType.SectionBreakNewPage); builder.Write("Text 3. "); builder.InsertFootnote(FootnoteType.Endnote, "Endnote 3."); builder.Write("Text 4. "); builder.InsertFootnote(FootnoteType.Endnote, "Endnote 4."); // By default, the reference symbol for each footnote and endnote is its index // among all the document's footnotes/endnotes. Each document maintains separate counts // for footnotes and endnotes and does not restart these counts at any point. Assert.That(FootnoteNumberingRule.Default, Is.EqualTo(doc.FootnoteOptions.RestartRule)); Assert.That(FootnoteNumberingRule.Continuous, Is.EqualTo(FootnoteNumberingRule.Default)); // We can use the "RestartRule" property to get the document to restart // the footnote/endnote counts at a new page or section. doc.FootnoteOptions.RestartRule = FootnoteNumberingRule.RestartPage; doc.EndnoteOptions.RestartRule = FootnoteNumberingRule.RestartSection; doc.Save(ArtifactsDir + "InlineStory.NumberingRule.docx"); ``` Shows how to set a number at which the document begins the footnote/endnote count. ```csharp Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Footnotes and endnotes are a way to attach a reference or a side comment to text // that does not interfere with the main body text's flow. // Inserting a footnote/endnote adds a small superscript reference symbol // at the main body text where we insert the footnote/endnote. // Each footnote/endnote also creates an entry, which consists of a symbol // that matches the reference symbol in the main body text. // The reference text that we pass to the document builder's "InsertEndnote" method. // Footnote entries, by default, show up at the bottom of each page that contains // their reference symbols, and endnotes show up at the end of the document. builder.Write("Text 1. "); builder.InsertFootnote(FootnoteType.Footnote, "Footnote 1."); builder.Write("Text 2. "); builder.InsertFootnote(FootnoteType.Footnote, "Footnote 2."); builder.Write("Text 3. "); builder.InsertFootnote(FootnoteType.Footnote, "Footnote 3."); builder.InsertParagraph(); builder.Write("Text 1. "); builder.InsertFootnote(FootnoteType.Endnote, "Endnote 1."); builder.Write("Text 2. "); builder.InsertFootnote(FootnoteType.Endnote, "Endnote 2."); builder.Write("Text 3. "); builder.InsertFootnote(FootnoteType.Endnote, "Endnote 3."); // By default, the reference symbol for each footnote and endnote is its index // among all the document's footnotes/endnotes. Each document maintains separate counts // for footnotes and for endnotes, which both begin at 1. Assert.That(doc.FootnoteOptions.StartNumber, Is.EqualTo(1)); Assert.That(doc.EndnoteOptions.StartNumber, Is.EqualTo(1)); // We can use the "StartNumber" property to get the document to // begin a footnote or endnote count at a different number. doc.EndnoteOptions.NumberStyle = NumberStyle.Arabic; doc.EndnoteOptions.StartNumber = 50; doc.Save(ArtifactsDir + "InlineStory.StartNumber.docx"); ``` ### See Also * property [FootnoteOptions](../../aspose.words/document/footnoteoptions/) * property [FootnoteOptions](../../aspose.words/pagesetup/footnoteoptions/) * namespace [Aspose.Words.Notes](../../aspose.words.notes/) * assembly [Aspose.Words](../../)