Note Class |
Represents a footnote or an endnote in the document.
Inheritance HierarchyNamespace: GemBox.Document
Assembly: GemBox.Document (in GemBox.Document.dll) Version: 29.0.35.1044
SyntaxThe Note type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Note(DocumentModel, NoteType, Block) |
Initializes a new instance of the Note class with specified note type and specified blocks.
|
| Note(DocumentModel, NoteType, IEnumerableBlock) |
Initializes a new instance of the Note class with specified note type and specified blocks.
|
| Note(DocumentModel, NoteType, String) |
Initializes a new instance of the Note class with specified note type and specified text.
|
Properties| Name | Description | |
|---|---|---|
 | Blocks |
Gets the Note's blocks.
|
| CharacterFormat |
Gets or sets the note mark character format.
|
| Content |
Gets the content of the current Element.
(Inherited from Element.) |
| CustomMark |
Gets or sets the custom mark.
|
| Document |
Gets the owner document.
(Overrides ElementDocument.) |
| ElementType |
Gets the ElementType of this Element instance.
(Overrides ElementElementType.) |
| NoteType |
Gets or sets the note type.
|
| Parent |
Gets the parent of this Element instance.
(Inherited from Element.) |
| ParentCollection |
Gets the InlineCollection that contains this Inline instance.
(Inherited from Inline.) |
Methods| Name | Description | |
|---|---|---|
| Clone |
Clones this Inline instance.
(Inherited from Inline.) |
| GetChildElements(Boolean) |
Gets the child elements.
(Inherited from Element.) |
| GetChildElements(Boolean, ElementType) |
Gets the child elements filtered by ElementType.
(Inherited from Element.) |
Explicit Interface Implementations| Name | Description | |
|---|---|---|
  | IContentElementContent |
Gets a sequence of ElementCollections that are contained under this IContentElement.
|
RemarksNote can be configured using NoteSettings on a document level (Footnote
and Endnote) or on a section level (FootnoteSettings and EndnoteSettings.
Document level settings are cloned when new Section is added to the DocumentModel.
Note is currently supported in DOCX and PDF formats. While DOCX format is fully supported, PDF format has the following limitations:
- Footnotes are always rendered on the same page as their references.
- Footnotes that don't fit on a single page are clipped.
- Note numbering setting RestartEachPage is not supported.
See Also