New to Telerik Document Processing? Start a free 30-day trial

Style

Class

Defines a named set of formatting properties that can be reused across multiple document elements with inheritance support.

Definition

Namespace:Telerik.Documents.Flow.Model.Styles

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

public class Style

Inheritance: objectStyle

Constructors

Style(string, StyleType)

Creates a new style with the specified identifier and type.

public Style(string id, StyleType type)

Parameters:idstring

The ID.

typeStyleType

The type.

Properties

BasedOnStyleId

string

Gets or sets the style ID from which this style inherits formatting properties.

public string BasedOnStyleId { get; set; }

Property Value:

The name of the based on.

CharacterProperties

Gets the character formatting properties applied by this style to text runs.

public CharacterProperties CharacterProperties { get; }

Property Value:

The character properties.

Document

RadFlowDocument

Gets the document that owns this style, or null if the style has not been added to a document.

public RadFlowDocument Document { get; }

Property Value:

The document.

Id

string

Gets or sets the unique identifier for this style; cannot be changed once the style is added to a document.

public string Id { get; set; }

Property Value:

The ID.

IsCustom

bool

Gets or sets whether this style is user-defined rather than built-in; defaults to false. The default value is

csharp

false

public bool IsCustom { get; set; }

IsDefault

bool

Gets or sets whether this style serves as the default for its type; cannot be changed once added to a document.

public bool IsDefault { get; set; }

Property Value:

The is default.

IsPrimary

bool

Gets or sets whether this style appears in the primary styles gallery in UI.

public bool IsPrimary { get; set; }

LinkedStyleId

string

Gets or sets the linked style ID that pairs this paragraph style with a character style or vice versa.

This property can be set to Paragraph or Character style only. Paragraph style can be linked only to Character style and vice versa.

public string LinkedStyleId { get; set; }

Property Value:

The linked style ID.

Name

string

Gets or sets the display name shown in UI; defaults to the style ID if not explicitly set.

public string Name { get; set; }

Property Value:

The name.

NextStyleId

string

Gets or sets the style ID automatically applied to the next paragraph after pressing Enter.

public string NextStyleId { get; set; }

Property Value:

The next style id.

ParagraphProperties

Gets the paragraph formatting properties applied by this style to paragraphs.

public ParagraphProperties ParagraphProperties { get; }

Property Value:

The paragraph properties.

StyleType

Gets the category of document elements to which this style applies.

public StyleType StyleType { get; }

Property Value:

The type of the style.

TableCellProperties

Gets the table cell formatting properties; only populated for table styles.

public TableCellProperties TableCellProperties { get; }

Property Value:

The table cell properties.

TableProperties

Gets the table formatting properties; only populated for table styles.

public TableProperties TableProperties { get; }

Property Value:

The table properties.

TableRowProperties

Gets the table row formatting properties; only populated for table styles.

public TableRowProperties TableRowProperties { get; }

Property Value:

The table row properties.

UIPriority

int

Gets or sets the sort order priority for displaying this style in UI lists; lower values appear first.

public int UIPriority { get; set; }

Property Value:

The UI priority.

Methods

Clone()

Creates a deep copy of this style with all properties and settings preserved.

public Style Clone()

Returns:

Style

The cloned style.

GetPropertyValue(IStylePropertyDefinition)

Retrieves the resolved value of a style property by evaluating the inheritance chain.

public object GetPropertyValue(IStylePropertyDefinition stylePropertyDefinition)

Parameters:stylePropertyDefinitionIStylePropertyDefinition

The style property definition.

Returns:

object