GrapeCity.Documents.Word

GrapeCity.Documents.Word.TextCollection

Class TextCollection

Namespace: GrapeCity.Documents.Word

Assembly: GcDocs.Word.dll

Represents a collection of Text objects.

public class TextCollection : ContentObjectCollection<Text>, IContentList<Text>, IReadOnlyList<Text>, IReadOnlyCollection<Text>, IEnumerable<Text>, IEnumerable

Inheritance: object

ContentCollection<Text>

ContentObjectCollection<Text>

TextCollection

Implements: IContentList<Text>

IReadOnlyList<Text>

IReadOnlyCollection<Text>

IEnumerable<Text>

IEnumerable

Inherited Members: ContentCollection<Text>.GetEnumerator()

ContentCollection<Text>.Print()

ContentCollection<Text>.DebugPrint()

ContentCollection<Text>.this[int]

ContentCollection<Text>.Count

ContentCollection<Text>.First

ContentCollection<Text>.Last

ContentCollection<Text>.Range

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

Add(string)

Adds a Text to this collection at the End location.

public Text Add(string value)

Parameters

value string: The text value to add.

Returns

Text: The added Text.

AddBreak()

Adds a line Break to this collection at the End location.

public Break AddBreak()

Returns

Break: The added Break.

AddBreak(BreakType)

Adds a Break to this collection at the End location.

public Break AddBreak(BreakType type)

Parameters

type BreakType: The break type.

Returns

Break: The added Break.

AddBreak(BreakType, BreakClear)

Adds a Break to this collection at the End location.

public Break AddBreak(BreakType type, BreakClear clear)

Parameters

type BreakType: The break type.
clear BreakClear: The location that shall be used as the next available line when the type has a value of TextWrapping.

Returns

Break: The added Break.

AddLastRenderedPageBreak()

Adds a LastRenderedPageBreak to this collection at the End location.

public LastRenderedPageBreak AddLastRenderedPageBreak()

Returns

LastRenderedPageBreak: The added LastRenderedPageBreak.

AddSymbol(char, string)

Adds a Symbol to this collection at the End location.

public Symbol AddSymbol(char character, string fontName)

Parameters

character char: The symbol character.
fontName string: The character font name.

Returns

Symbol: The added Symbol.

AddTab()

Adds a Tab to this collection at the End location.

public Tab AddTab()

Returns

Tab: The added Tab.

AddTab(TabAlignment)

Adds a Tab to this collection at the End location.

public Tab AddTab(TabAlignment alignment)

Parameters

alignment TabAlignment: The tab alignment.

Returns

Tab: The added Tab.

AddTab(TabAlignment, TabLeader)

Adds a Tab to this collection at the End location.

public Tab AddTab(TabAlignment alignment, TabLeader leader)

Parameters

alignment TabAlignment: The tab alignment.
leader TabLeader: The tab leader character.

Returns

Tab: The added Tab.

AddTab(TabAlignment, TabLeader, TabRelativeTo)

Adds a Tab to this collection at the End location.

public Tab AddTab(TabAlignment alignment, TabLeader leader, TabRelativeTo relativeTo)

Parameters

alignment TabAlignment: The tab alignment.
leader TabLeader: The tab leader character.
relativeTo TabRelativeTo: The extent to calculate the position of the tab.

Returns

Tab: The added Tab.

Insert(string, InsertLocation)

Inserts a Text into this collection at a specified location.

public Text Insert(string value, InsertLocation location)

Parameters

value string: The text value to insert.
location InsertLocation: The target InsertLocation for the insertion.

Returns

Text: The inserted Text.

InsertBreak(BreakType, BreakClear, InsertLocation)

Inserts a Break into this collection at a specified location.

public Break InsertBreak(BreakType type, BreakClear clear, InsertLocation location)

Parameters

type BreakType: The break type.
clear BreakClear: The location that shall be used as the next available line when the type has a value of TextWrapping.
location InsertLocation: The target InsertLocation for the insertion.

Returns

Break: The inserted Break.

InsertBreak(BreakType, InsertLocation)

Inserts a Break into this collection at a specified location.

public Break InsertBreak(BreakType type, InsertLocation location)

Parameters

type BreakType: The break type.
location InsertLocation: The target InsertLocation for the insertion.

Returns

Break: The inserted Break.

InsertBreak(InsertLocation)

Inserts a line Break into this collection at a specified location.

public Break InsertBreak(InsertLocation location)

Parameters

location InsertLocation: The target InsertLocation for the insertion.

Returns

Break: The inserted Break.

InsertLastRenderedPageBreak(InsertLocation)

Inserts a LastRenderedPageBreak into this collection at a specified location.

public LastRenderedPageBreak InsertLastRenderedPageBreak(InsertLocation location)

Parameters

location InsertLocation: The target InsertLocation for the insertion.

Returns

LastRenderedPageBreak: The inserted LastRenderedPageBreak.

InsertSymbol(char, string, InsertLocation)

Inserts a Symbol into this collection at a specified location.

public Symbol InsertSymbol(char character, string fontName, InsertLocation location)

Parameters

character char: The symbol character.
fontName string: The character font name.
location InsertLocation: The target InsertLocation for the insertion.

Returns

Symbol: The inserted Symbol.

InsertTab(InsertLocation)

Inserts a Tab into this collection at a specified location.

public Tab InsertTab(InsertLocation location)

Parameters

location InsertLocation: The target InsertLocation for the insertion.

Returns

Tab: The inserted Tab.

InsertTab(TabAlignment, InsertLocation)

Inserts a Tab into this collection at a specified location.

public Tab InsertTab(TabAlignment alignment, InsertLocation location)

Parameters

alignment TabAlignment: The tab alignment.
location InsertLocation: The target InsertLocation for the insertion.

Returns

Tab: The inserted Tab.

InsertTab(TabAlignment, TabLeader, InsertLocation)

Inserts a Tab into this collection at a specified location.

public Tab InsertTab(TabAlignment alignment, TabLeader leader, InsertLocation location)

Parameters

alignment TabAlignment: The tab alignment.
leader TabLeader: The tab leader character.
location InsertLocation: The target InsertLocation for the insertion.

Returns

Tab: The inserted Tab.

InsertTab(TabAlignment, TabLeader, TabRelativeTo, InsertLocation)

Inserts a Tab into this collection at a specified location.

public Tab InsertTab(TabAlignment alignment, TabLeader leader, TabRelativeTo relativeTo, InsertLocation location)

Parameters

alignment TabAlignment: The tab alignment.
leader TabLeader: The tab leader character.
relativeTo TabRelativeTo: The extent to calculate the position of the tab.
location InsertLocation: The target InsertLocation for the insertion.

Returns

Tab: The inserted Tab.