Note Class

Namespace:: GemBox.Document

Assembly:: GemBox.Document.dll

Represents a footnote or an endnote in the document.

C#
VB.NET

public sealed class Note : Inline, IContentElement

Public NotInheritable Class Note
    Inherits Inline
    Implements IContentElement

Inheritance:: System.Object
Element
Inline
Note

Implements

IContentElement

Remarks

Note 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.

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.

HTML and TXT formats have the following limitations:

All footnotes and then endnotes are exported at the end of the document.
Note numbering setting RestartEachPage is not supported.

Constructors

Note(DocumentModel, NoteType)

Initializes a new instance of the Note class with specified note type.

C#
VB.NET

public Note(DocumentModel document, NoteType noteType)

Public Sub New(document As DocumentModel, noteType As NoteType)

Parameters

document: DocumentModel

The owner document.

noteType: NoteType

The note type.

Note(DocumentModel, NoteType, Block[])

Initializes a new instance of the Note class with specified note type and specified Block.

C#
VB.NET

public Note(DocumentModel document, NoteType noteType, params Block[] items)

Public Sub New(document As DocumentModel, noteType As NoteType, ParamArray items As Block())

Parameters

document: DocumentModel

The owner document.

noteType: NoteType

The note type.

items: Block[]

The Note content.

Note(DocumentModel, NoteType, IEnumerable<Block>)

Initializes a new instance of the Note class with specified note type and specified Block.

C#
VB.NET

public Note(DocumentModel document, NoteType noteType, IEnumerable<Block> items)

Public Sub New(document As DocumentModel, noteType As NoteType, items As IEnumerable(Of Block))

Parameters

document: DocumentModel

The owner document.

noteType: NoteType

The note type.

items: System.Collections.Generic.IEnumerable<Block>

The Note content.

Note(DocumentModel, NoteType, String)

Initializes a new instance of the Note class with specified note type and specified text.

C#
VB.NET

public Note(DocumentModel document, NoteType noteType, string text)

Public Sub New(document As DocumentModel, noteType As NoteType, text As String)

Parameters

document: DocumentModel

The owner document.

noteType: NoteType

The note type.

text: System.String

The text content for this Note instance.

Properties

Blocks

Gets the Note's blocks.

C#
VB.NET

public BlockCollection Blocks { get; }

Public ReadOnly Property Blocks As BlockCollection

Property Value

BlockCollection

The Note's blocks.

Remarks

Supports all Block derived elements: Paragraph, Table and TableOfEntries.

CharacterFormat

Gets or sets the note mark character format.

C#
VB.NET

public CharacterFormat CharacterFormat { get; set; }

Public Property CharacterFormat As CharacterFormat

Property Value

CharacterFormat

The note mark character format.

Remarks

This property is defined as direct formatting, since it is directly applied to the run and supersede any formatting from styles.

For more information about paragraph formatting, see character formatting example.

CustomMark

Gets or sets the custom mark.

C#
VB.NET

public string CustomMark { get; set; }

Public Property CustomMark As String

Property Value

System.String

The custom mark.

Remarks

If not null or empty, custom mark will be used as a note mark instead of automatically generated value determined by NumberStyle.

Document

Gets the owner document.

C#
VB.NET

public override DocumentModel Document { get; }

Public Overrides ReadOnly Property Document As DocumentModel

Property Value

DocumentModel

The owner document.

Overrides

Element.Document

ElementType

Gets the ElementType of this Element instance.

C#
VB.NET

public override ElementType ElementType { get; }

Public Overrides ReadOnly Property ElementType As ElementType

Property Value

ElementType

The ElementType of this Element instance.

Overrides

Element.ElementType

NoteType

Gets or sets the note type.

C#
VB.NET

public NoteType NoteType { get; }

Public ReadOnly Property NoteType As NoteType

Property Value

NoteType

The note type.

Inherited Properties

Content	Gets the content of the current Element. (Inherited from Element)
Parent	Gets the parent of this Element instance. (Inherited from Element)
ParentCollection	Gets the InlineCollection that contains this Inline instance. (Inherited from Inline)
Revision	Gets or sets the revision information for the inline. (Inherited from Inline)

Inherited Methods

Clone(System.Boolean)	Clones this Inline instance. (Inherited from Inline)
GetChildElements(System.Boolean)	Gets the child elements. (Inherited from Element)
GetChildElements(System.Boolean, ElementType[])	Gets the child elements filtered by ElementType. (Inherited from Element)
GetParentElements()	Gets the parent elements. (Inherited from Element)
GetParentElements(ElementType[])	Gets the parent elements. (Inherited from Element)

Implements

IContentElement