Class
CaptionDefinition

Represents a definition for a caption.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class CaptionDefinition

Inheritance: objectCaptionDefinition

Constructors

CaptionDefinition()

Initializes a new instance of the CaptionDefinition class.

Declaration

cs-api-definition
public CaptionDefinition()

CaptionDefinition(string, NumberingFormat)

Initializes a new instance of the CaptionDefinition class.

Declaration

cs-api-definition
public CaptionDefinition(string label, NumberingFormat format = NumberingFormat.Arabic)

Parameters

label

string

The label.

format

NumberingFormat

The format.

CaptionDefinition(string, NumberingFormat, int, CaptionSeparatorType)

Initializes a new instance of the CaptionDefinition class.

Declaration

cs-api-definition
public CaptionDefinition(string label, NumberingFormat format, int linkedHeadingLevel, CaptionSeparatorType separator = CaptionSeparatorType.Hyphen)

Parameters

label

string

The label.

format

NumberingFormat

The format.

linkedHeadingLevel

int

The linked heading level.

separator

CaptionSeparatorType

The separator.

Properties

IsDefault

Gets or sets a value indicating whether this instance is a default caption.

Declaration

cs-api-definition
[XamlSerializable]
public bool IsDefault { get; set; }

Property Value

bool

true if this instance is default; otherwise, false.

IsLinkedToHeading

Gets or sets a value indicating whether this instance is linked to a heading.

Declaration

cs-api-definition
[XamlSerializable]
public bool IsLinkedToHeading { get; set; }

Property Value

bool

true if this instance is linked to heading; otherwise, false.

Label

Gets or sets the label.

Declaration

cs-api-definition
[XamlSerializable]
public string Label { get; set; }

Property Value

string

The label.

LinkedHeadingLevel

Gets or sets the linked heading level.

Declaration

cs-api-definition
[XamlSerializable]
public int LinkedHeadingLevel { get; set; }

Property Value

int

The linked heading level.

NumberingFormat

Gets or sets the numbering format.

Declaration

cs-api-definition
[XamlSerializable]
public NumberingFormat NumberingFormat { get; set; }

Property Value

NumberingFormat

The numbering format.

SeparatorType

Gets or sets the type of the separator.

Declaration

cs-api-definition
[XamlSerializable]
public CaptionSeparatorType SeparatorType { get; set; }

Property Value

CaptionSeparatorType

The type of the separator.