GrapeCity.Documents.Word.TextColumnCollection

Class TextColumnCollection

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents a collection of TextColumn objects that represent all columns of text in a section.

public class TextColumnCollection : IEnumerable<TextColumn>, IEnumerable

Inheritance

object

TextColumnCollection

Implements

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

System.Collections.IEnumerable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Count

Gets the number of columns in the section of a document.

public short Count { get; }

Property Value

short

EvenlySpaced

Gets or sets a value indicating whether all text columns are of equal width and evenly spaced.

public bool EvenlySpaced { get; set; }

Property Value

bool

Remarks

If you set Spacing or Width on this TextColumnCollection, this property will be automatically set to true. Also, setting this property may change Spacing and Width values.

this[int]

Gets a text column at a specified index.

public TextColumn this[int index] { get; }

Parameters

index int

The column index.

Property Value

TextColumn

A text column at the specified index.

LineBetween

Gets or sets a value indicating whether to add a vertical line between columns.

public bool LineBetween { get; set; }

Property Value

bool

Spacing

When columns are evenly spaced (see EvenlySpaced), gets or sets the amount of space between each column in points.

public float Spacing { get; set; }

Property Value

float

Width

When columns are evenly spaced (see EvenlySpaced), gets or sets the width of the columns.

public float Width { get; set; }

Property Value

float

Methods

Add()

Adds a new TextColumn to the section.

public TextColumn Add()

Returns

TextColumn

The newly created TextColumn.

Add(float, float)

Adds a new TextColumn to the section.

This method sets the EvenlySpaced property to false.

public TextColumn Add(float width, float spaceAfter)

Parameters

width float

The width of the new text column, in points.

spaceAfter float

The space between this column and the next column, in points.

Returns

TextColumn

The newly created TextColumn.

Add(float)

Adds a new TextColumn to the section.

public TextColumn Add(float width)

Parameters

width float

The width of the new text column, in points.

Returns

TextColumn

The newly created TextColumn.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<TextColumn> GetEnumerator()

Returns

System.Collections.Generic.IEnumerator<T><TextColumn>

An enumerator that can be used to iterate through the collection.

SetCount(short)

Sets the number of columns in a section of a document.

public void SetCount(short count)

Parameters

count short

The number of text columns in the section.