New to Telerik UI for WinFormsStart a free 30-day trial

Represents a definition for a caption.

Definition

Namespace:Telerik.WinForms.Documents.Model

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public class CaptionDefinition

Inheritance: objectCaptionDefinition

Constructors

Initializes a new instance of the CaptionDefinition class.

C#
public CaptionDefinition()

Initializes a new instance of the CaptionDefinition class.

C#
public CaptionDefinition(string label, NumberingFormat format, int linkedHeadingLevel, CaptionSeparatorType separator = CaptionSeparatorType.Hyphen)
Parameters:labelstring

The label.

formatNumberingFormat

The format.

linkedHeadingLevelint

The linked heading level.

separatorCaptionSeparatorType

The separator.

Initializes a new instance of the CaptionDefinition class.

C#
public CaptionDefinition(string label, NumberingFormat format = NumberingFormat.Arabic)
Parameters:labelstring

The label.

formatNumberingFormat

The format.

Properties

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

C#
[XamlSerializable]
public bool IsDefault { get; set; }
Property Value:

true if this instance is default; otherwise, false.

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

C#
[XamlSerializable]
public bool IsLinkedToHeading { get; set; }
Property Value:

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

Gets or sets the label.

C#
[XamlSerializable]
public string Label { get; set; }
Property Value:

The label.

Gets or sets the linked heading level.

C#
[XamlSerializable]
public int LinkedHeadingLevel { get; set; }
Property Value:

The linked heading level.

Gets or sets the numbering format.

C#
[XamlSerializable]
public NumberingFormat NumberingFormat { get; set; }
Property Value:

The numbering format.

Gets or sets the type of the separator.

C#
[XamlSerializable]
public CaptionSeparatorType SeparatorType { get; set; }
Property Value:

The type of the separator.