ParagraphStyle.LinkedStyle Property

Gets or sets the linked style for the current style.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

CharacterStyle LinkedStyle { get; set; }

VB.NET

Property LinkedStyle As CharacterStyle

Property Value

Type	Description
CharacterStyle	A ParagraphStyle object representing a paragraph style linked to a current style

Remarks

A linked style can act as a paragraph style or a character style, depending on the range to which it is applied.

If a linked style is applied to a selection which does not include an entire paragraph, the selected text is formatted with the character formatting settings of the linked styles.

If a selection includes an entire paragraph, both character and paragraph formatting settings are applied.

If a selection is just a caret position and contains no characters, the linked style behaves like a paragraph style.

You should specify the LinkedStyle property only once, for one of the linked styles.

Note

Assigning a style via the LinkedStyle property results in overwriting the corresponding settings of the style to which the style becomes linked. So you are advised to link styles first, and specify their settings afterwards.

The following code snippet demonstrates how to create linked styles.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Styles.vb

document.BeginUpdate()
document.AppendText("Line One" & vbLf & "Line Two" & vbLf & "Line Three")
document.EndUpdate()

'Create new paragraph style
Dim lstyle As ParagraphStyle = document.ParagraphStyles("MyLinkedStyle")
If lstyle Is Nothing Then
    document.BeginUpdate()
    lstyle = document.ParagraphStyles.CreateNew()
    lstyle.Name = "MyLinkedStyle"
    lstyle.LineSpacingType = ParagraphLineSpacing.Double
    lstyle.Alignment = ParagraphAlignment.Center
    document.ParagraphStyles.Add(lstyle)

    Dim lcstyle As CharacterStyle = document.CharacterStyles.CreateNew()
    lcstyle.Name = "MyLinkedCStyle"
    document.CharacterStyles.Add(lcstyle)
    lcstyle.LinkedStyle = lstyle

    lcstyle.ForeColor = System.Drawing.Color.DarkGreen
    lcstyle.Strikeout = StrikeoutType.Single
    lcstyle.FontSize = 24
    document.EndUpdate()

    'Apply created styles 
    'to the text range and to the entire paragraph
    document.Paragraphs(1).Style = lstyle

    Dim myRange As DocumentRange = document.Paragraphs(0).Range
    Dim charProps As CharacterProperties = document.BeginUpdateCharacters(myRange)
    charProps.Style = lcstyle
    document.EndUpdateCharacters(charProps)
End If

Styles.cs

document.BeginUpdate();
document.AppendText("Line One\nLine Two\nLine Three");
document.EndUpdate();

//Create new paragraph style
ParagraphStyle lstyle = document.ParagraphStyles["MyLinkedStyle"];
if (lstyle == null)
{
    document.BeginUpdate();
    lstyle = document.ParagraphStyles.CreateNew();
    lstyle.Name = "MyLinkedStyle";
    lstyle.LineSpacingType = ParagraphLineSpacing.Double;
    lstyle.Alignment = ParagraphAlignment.Center;
    document.ParagraphStyles.Add(lstyle);

    CharacterStyle lcstyle = document.CharacterStyles.CreateNew();
    lcstyle.Name = "MyLinkedCStyle";
    document.CharacterStyles.Add(lcstyle);
    lcstyle.LinkedStyle = lstyle;

    lcstyle.ForeColor = System.Drawing.Color.DarkGreen;
    lcstyle.Strikeout = StrikeoutType.Single;
    lcstyle.FontSize = 24;
    document.EndUpdate();

    //Apply created styles 
    //to the text range and to the entire paragraph
    document.Paragraphs[1].Style = lstyle;

    DocumentRange myRange = document.Paragraphs[0].Range;
    CharacterProperties charProps = document.BeginUpdateCharacters(myRange);
    charProps.Style = lcstyle;
    document.EndUpdateCharacters(charProps);
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LinkedStyle property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

VB.NET

how-to-change-formatting-of-text-and-paragraph-e2206/VB/HowToChangeFormatting/Form1.vb#L121

pstyle = doc.ParagraphStyles.CreateNew()
pstyle.LinkedStyle = cstyle
pstyle.Name = "MyLinkedParagraphStyle"