CharacterStyle Interface

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

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v20.2.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 accept/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.

View Example

StylesActions.cs

Document document = server.Document;
server.LoadDocument("Documents\\Grimm.docx", 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);

StylesActions.vb

Dim document As Document = server.Document
server.LoadDocument("Documents\Grimm.docx", 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)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CharacterStyle interface.

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.

C#

how-to-change-formatting-of-text-and-paragraph-e2206/CS/HowToChangeFormatting/Form1.cs#L74

Document doc = richEditControl1.Document;
CharacterStyle cstyle = doc.CharacterStyles["MyCharStyle"];

how-to-create-and-apply-document-styles-e2670/CS/Styles/Form1.cs#L28

#region #cstyle
CharacterStyle cStyle = richEditControl1.Document.CharacterStyles["MyCharStyle"];
if (cStyle == null)

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/StylesActions.cs#L16

document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
CharacterStyle cstyle = document.CharacterStyles["MyCStyle"];
if (cstyle == null)

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Styles.cs#L16

document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
CharacterStyle cstyle = document.CharacterStyles["MyCStyle"];
if (cstyle == null)

word-processing-document-api-examples-t418535/CS/CodeExamples/StylesActions.cs#L18

wordProcessor.LoadDocument("Documents\\Grimm.docx", DocumentFormat.OpenXml);
CharacterStyle cstyle = document.CharacterStyles["MyCStyle"];
if (cstyle == null)

VB.NET

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

Dim doc As Document = richEditControl1.Document
Dim cstyle As CharacterStyle = doc.CharacterStyles("MyCharStyle")

how-to-create-and-apply-document-styles-e2670/VB/Styles/Form1.vb#L26

'    #Region "#cstyle"
    Dim cStyle As CharacterStyle = richEditControl1.Document.CharacterStyles("MyCharStyle")
    If cStyle Is Nothing Then

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/StylesActions.vb#L13

document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
Dim cstyle As CharacterStyle = document.CharacterStyles("MyCStyle")
If cstyle Is Nothing Then

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Styles.vb#L13

document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
Dim cstyle As CharacterStyle = document.CharacterStyles("MyCStyle")
If cstyle Is Nothing Then

word-processing-document-api-examples-t418535/VB/CodeExamples/StylesActions.vb#L15

wordProcessor.LoadDocument("Documents\Grimm.docx", DocumentFormat.OpenXml)
Dim cstyle As CharacterStyle = document.CharacterStyles("MyCStyle")
If cstyle Is Nothing Then