Document.DefaultCharacterProperties Property

Provides access to default character formatting for the current document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v18.2.Core.dll

Declaration

C#

CharacterPropertiesBase DefaultCharacterProperties { get; }

VB.NET

ReadOnly Property DefaultCharacterProperties As CharacterPropertiesBase

Property Value

Type	Description
CharacterPropertiesBase	A CharacterPropertiesBase interface that enables you to specify character properties.

Remarks

The DefaultCharacterProperties property enables you to specify default character formatting for a loaded or newly created document. These settings override the RichEditControlCompatibility.DefaultFontName and RichEditControlCompatibility.DefaultFontSize property values.

When formatting is reset by executing the ClearFormattingCommand, character properties are set to default values specified via the DefaultCharacterProperties property.

Example

The following code snippet illustrates how to apply default character formatting to a just loaded document. The RichEditControl.DocumentLoaded event is handled and the Document.DefaultCharacterProperties settings are modified.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-specify-default-document-formatting-e1398

Form1.vb

Private Sub RichEditControl1_DocumentLoaded(ByVal sender As Object, ByVal e As EventArgs)
    richEditControl1.Document.DefaultCharacterProperties.FontName = "Arial"
    richEditControl1.Document.DefaultCharacterProperties.FontSize = 16
End Sub

Form1.cs

private void RichEditControl1_DocumentLoaded(object sender, EventArgs e) {
    richEditControl1.Document.DefaultCharacterProperties.FontName = "Arial";
    richEditControl1.Document.DefaultCharacterProperties.FontSize = 16;
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DefaultCharacterProperties 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.

C#

how-to-set-tab-stops-so-that-each-tab-is-of-certain-characters-width-e3198/CS/TabStop_EachNCharacters/Form1.cs#L31

Document document = richEditControl1.Document;
SizeF tabSize = richEditControl1.MeasureSingleLineString(new String(' ', 4), document.DefaultCharacterProperties);
TabInfoCollection tabs = document.Paragraphs[0].BeginUpdateTabs(true);

how-to-set-tab-stops-so-that-each-tab-is-of-certain-characters-width-e5203/CS/TabStop_EachNCharacters/MainWindow.xaml.cs#L41

DevExpress.XtraRichEdit.API.Native.Document document = richEditControl1.Document;
SizeF tabSize = richEditControl1.MeasureSingleLineString(new String('w', 4), document.DefaultCharacterProperties);
DevExpress.XtraRichEdit.API.Native.TabInfoCollection tabs = document.Paragraphs[0].BeginUpdateTabs(true);

VB.NET

how-to-set-tab-stops-so-that-each-tab-is-of-certain-characters-width-e3198/VB/TabStop_EachNCharacters/Form1.vb#L29

Dim document As Document = richEditControl1.Document
Dim tabSize As SizeF = richEditControl1.MeasureSingleLineString(New String(" "c, 4), document.DefaultCharacterProperties)
Dim tabs As TabInfoCollection = document.Paragraphs(0).BeginUpdateTabs(True)

how-to-set-tab-stops-so-that-each-tab-is-of-certain-characters-width-e5203/VB/TabStop_EachNCharacters/MainWindow.xaml.vb#L35

Dim document As DevExpress.XtraRichEdit.API.Native.Document = richEditControl1.Document
Dim tabSize As SizeF = richEditControl1.MeasureSingleLineString(New String("w"c, 4), document.DefaultCharacterProperties)
Dim tabs As DevExpress.XtraRichEdit.API.Native.TabInfoCollection = document.Paragraphs(0).BeginUpdateTabs(True)