CharacterStyle Interface

Exposes methods and characteristics of a character style in a document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[ComVisible(true)]
public interface CharacterStyle :
    CharacterPropertiesBase

VB.NET

<ComVisible(True)>
Public Interface CharacterStyle
    Inherits CharacterPropertiesBase

Related API Members

The following members return CharacterStyle objects:

• CharacterProperties.Style
• CharacterStyle.Parent
• CharacterStyleCollection.CreateNew()
• CharacterStyleCollection.Item[String]
• ParagraphStyle.LinkedStyle

Remarks

A style pertains to a document. It belongs to a particular document model, and you cannot add a style object from the style collection of one document to the style collection of another.

The following code snippet creates a new character style via the CharacterStyleCollection.CreateNew method, specifies style settings, adds it to the document style collection and applies the style to the specified range.

Note

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

Styles.vb

document.LoadDocument("Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
Dim cstyle As CharacterStyle = document.CharacterStyles("MyCStyle")
If cstyle Is Nothing Then
    cstyle = document.CharacterStyles.CreateNew()
    cstyle.Name = "MyCStyle"
    cstyle.Parent = document.CharacterStyles("Default Paragraph Font")
    cstyle.ForeColor = System.Drawing.Color.DarkOrange
    cstyle.Strikeout = StrikeoutType.Double
    cstyle.FontName = "Verdana"
    document.CharacterStyles.Add(cstyle)
End If
Dim myRange As DocumentRange = document.Paragraphs(0).Range
Dim charProps As CharacterProperties = document.BeginUpdateCharacters(myRange)
charProps.Style = cstyle
document.EndUpdateCharacters(charProps)

Styles.cs

document.LoadDocument("Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
CharacterStyle cstyle = document.CharacterStyles["MyCStyle"];
if (cstyle == null)
{
    cstyle = document.CharacterStyles.CreateNew();
    cstyle.Name = "MyCStyle";
    cstyle.Parent = document.CharacterStyles["Default Paragraph Font"];
    cstyle.ForeColor = System.Drawing.Color.DarkOrange;
    cstyle.Strikeout = StrikeoutType.Double;
    cstyle.FontName = "Verdana";
    document.CharacterStyles.Add(cstyle);
}
DocumentRange myRange = document.Paragraphs[0].Range;
CharacterProperties charProps =
    document.BeginUpdateCharacters(myRange);
charProps.Style = cstyle;
document.EndUpdateCharacters(charProps);