GrapeCity.Documents.Word.FootnoteCollection

Class FootnoteCollection

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents a collection of Footnote objects.

public class FootnoteCollection : ContentObjectCollection<Footnote>, IContentList<Footnote>, IReadOnlyList<Footnote>, IReadOnlyCollection<Footnote>, IEnumerable<Footnote>, IEnumerable

Inheritance

object

ContentCollection<Footnote>

ContentObjectCollection<Footnote>

FootnoteCollection

Implements

IContentList<Footnote>

IReadOnlyList<Footnote>

IReadOnlyCollection<Footnote>

IEnumerable<Footnote>

IEnumerable

Inherited Members

ContentCollection<Footnote>.GetEnumerator()

ContentCollection<Footnote>.Print()

ContentCollection<Footnote>.DebugPrint()

ContentCollection<Footnote>.this[int]

ContentCollection<Footnote>.Count

ContentCollection<Footnote>.First

ContentCollection<Footnote>.Last

ContentCollection<Footnote>.Range

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

ContinuationNotice

Gets the body of the footnotes continuation notice.

public Body ContinuationNotice { get; }

Property Value

Body

ContinuationSeparator

Gets the body of the footnotes continuation separator.

public Body ContinuationSeparator { get; }

Property Value

Body

Separator

Gets the body of the footnotes separator.

public Body Separator { get; }

Property Value

Body

Methods

Add(string)

Adds a Footnote to this collection at the End location.

public Footnote Add(string text = null)

Parameters

text string

The footnote text.

Returns

Footnote

The added Footnote.

Add(string, char, string)

Adds a Footnote to this collection at the End location.

public Footnote Add(string text, char referenceCharacter, string referenceFontName)

Parameters

text string

The footnote text.

referenceCharacter char

The footnote reference symbol.

referenceFontName string

The footnote reference symbol font.

Returns

Footnote

The added Footnote.

Add(string, string)

Adds a Footnote to this collection at the End location.

public Footnote Add(string text, string reference)

Parameters

text string

The footnote text.

reference string

The footnote reference text.

Returns

Footnote

The added Footnote.

Contains(long)

Checks whether this collection contains a footnote with a specified ID.

public bool Contains(long id)

Parameters

id long

The footnote ID.

Returns

bool

True if the collection contains a footnote with the specified ID, false otherwise.

GetByID(long)

Gets a footnote from the collection by its ID.

public Footnote GetByID(long id)

Parameters

id long

The footnote ID.

Returns

Footnote

The Footnote with the specified ID.

Exceptions

KeyNotFoundException

Throws if a footnote with the specified ID could not be found in the collection.

Insert(InsertLocation)

Inserts a Footnote into this collection at the specified location.

public Footnote Insert(InsertLocation location)

Parameters

location InsertLocation

The target InsertLocation for the insertion.

Returns

Footnote

The inserted Footnote.

Insert(string, InsertLocation)

Inserts a Footnote into this collection at the specified location.

public Footnote Insert(string text, InsertLocation location)

Parameters

text string

The footnote text.

location InsertLocation

The target InsertLocation for the insertion.

Returns

Footnote

The inserted Footnote.

Insert(string, char, string, InsertLocation)

Inserts a Footnote into this collection at the specified location.

public Footnote Insert(string text, char referenceCharacter, string referenceFontName, InsertLocation location)

Parameters

text string

The footnote text.

referenceCharacter char

The footnote reference symbol.

referenceFontName string

The footnote reference symbol font.

location InsertLocation

The target InsertLocation for the insertion.

Returns

Footnote

The inserted Footnote.

Insert(string, string, InsertLocation)

Inserts a Footnote into this collection at the specified location.

public Footnote Insert(string text, string reference, InsertLocation location)

Parameters

text string

The footnote text.

reference string

The footnote reference text.

location InsertLocation

The target InsertLocation for the insertion.

Returns

Footnote

The inserted Footnote.