GrapeCity.Documents.Word

GrapeCity.Documents.Word.EndnoteCollection

Class EndnoteCollection

Namespace: GrapeCity.Documents.Word

Assembly: GcDocs.Word.dll

Represents a collection of Endnote objects.

public class EndnoteCollection : ContentObjectCollection<Endnote>, IContentList<Endnote>, IReadOnlyList<Endnote>, IReadOnlyCollection<Endnote>, IEnumerable<Endnote>, IEnumerable

Inheritance: object

ContentCollection<Endnote>

ContentObjectCollection<Endnote>

EndnoteCollection

Implements: IContentList<Endnote>

System.Collections.Generic.IReadOnlyList<T><Endnote>

System.Collections.Generic.IReadOnlyCollection<T><Endnote>

System.Collections.Generic.IEnumerable<T><Endnote>

System.Collections.IEnumerable

Inherited Members: ContentCollection<Endnote>.GetEnumerator()

ContentCollection<Endnote>.Print()

ContentCollection<Endnote>.DebugPrint()

ContentCollection<Endnote>.this[int]

ContentCollection<Endnote>.Count

ContentCollection<Endnote>.First

ContentCollection<Endnote>.Last

ContentCollection<Endnote>.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 endnotes continuation notice.

public Body ContinuationNotice { get; }

Property Value

Body

ContinuationSeparator

Gets the body of the endnotes continuation separator.

public Body ContinuationSeparator { get; }

Property Value

Body

Separator

Gets the body of the endnotes separator.

public Body Separator { get; }

Property Value

Body

Methods

Add(string, char, string)

Adds an Endnote into the collection at the End position.

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

Parameters

text string: The endnote text.
referenceCharacter char: The endnote reference symbol.
referenceFontName string: The endnote reference symbol font.

Returns

Endnote: The added Endnote.

Add(string, string)

Adds an Endnote into the collection at the End position.

public Endnote Add(string text, string reference)

Parameters

text string: The endnote text.
reference string: The endnote reference text.

Returns

Endnote: The added Endnote.

Add(string)

Adds an Endnote into this collection at the End location.

public Endnote Add(string text = null)

Parameters

text string: The endnote text.

Returns

Endnote: The added Endnote.

Contains(long)

Checks whether this collection contains an endnote with a specified ID.

public bool Contains(long id)

Parameters

id long: The endnote ID.

Returns

bool: True if the collection contains an endnote with the specified ID, false otherwise.

GetByID(long)

Gets an endnote from the collection by its ID.

public Endnote GetByID(long id)

Parameters

id long: The endnote ID.

Returns

Endnote: The Endnote with the specified ID.

Exceptions

System.Collections.Generic.KeyNotFoundException: Thrown when an endnote with the specified ID could not be found in this collection.

Insert(InsertLocation)

Inserts an Endnote into this collection at the specified location.

public Endnote Insert(InsertLocation location)

Parameters

location InsertLocation: The target InsertLocation for the insertion.

Returns

Endnote: The inserted Endnote.

Insert(string, InsertLocation)

Inserts an Endnote into this collection at the specified location.

public Endnote Insert(string text, InsertLocation location)

Parameters

text string: The endnote text.
location InsertLocation: The target InsertLocation for the insertion.

Returns

Endnote: The inserted Endnote.

Insert(string, char, string, InsertLocation)

Inserts an Endnote into this collection at the specified location.

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

Parameters

text string: The endnote text.
referenceCharacter char: The endnote reference symbol.
referenceFontName string: The endnote reference symbol font.
location InsertLocation: The target InsertLocation for the insertion.

Returns

Endnote: The inserted Endnote.

Insert(string, string, InsertLocation)

Inserts an Endnote into this collection at the specified location.

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

Parameters

text string: The endnote text.
reference string: The endnote reference text.
location InsertLocation: The target InsertLocation for the insertion.

Returns

Endnote: The inserted Endnote.