[]
        
(Showing Draft Content)

GrapeCity.Documents.Word.Fields.OutlineLevelRange

Class OutlineLevelRange

Namespace
GrapeCity.Documents.Word.Fields
Assembly
GcDocs.Word.dll

Represents a range of OutlineLevel enum values.

public class OutlineLevelRange
Inheritance
OutlineLevelRange
Inherited Members

Properties

From

Gets the range start outline level.

public OutlineLevel From { get; }

Property Value

OutlineLevel

IsEmpty

Gets a value indicating whether the range does not have any outline levels.

public bool IsEmpty { get; }

Property Value

bool

IsMax

Gets a value indicating whether the range is from Level1 to Level9.

public bool IsMax { get; }

Property Value

bool

To

Gets the range end outline level.

public OutlineLevel To { get; }

Property Value

OutlineLevel

Methods

Empty()

Makes the range empty.

public void Empty()

InRange(OutlineLevel)

Gets whether the given outline level is in the range.

public bool InRange(OutlineLevel level)

Parameters

level OutlineLevel

The outline level to check.

Returns

bool

true if the outline level is in the range, otherwise false.

Max()

Sets the range from Level1 to Level9.

public void Max()

Set(OutlineLevel, OutlineLevel)

Sets the level range.

public void Set(OutlineLevel from, OutlineLevel to)

Parameters

from OutlineLevel

The range start outline level.

to OutlineLevel

The range end outline level.

Exceptions

ArgumentOutOfRangeException

Thrown if trying to set BodyText.

ArgumentOutOfRangeException

Thrown if trying to set from less than to.

ToArray()

Gets the array of OutlineLevel values defined in the range.

public OutlineLevel[] ToArray()

Returns

OutlineLevel[]

The array of OutlineLevel values defined in the range.

ToString()

public override string ToString()

Returns

string