Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

RichEditControl.MeasureSingleLineString(String, CharacterPropertiesBase) Method

Calculates the length of a formatted string.

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v24.2.dll

NuGet Package: DevExpress.Wpf.RichEdit

#Declaration

public SizeF MeasureSingleLineString(
    string text,
    CharacterPropertiesBase properties
)

#Parameters

Name Type Description
text String

A string to measure.

properties CharacterPropertiesBase

A CharacterPropertiesBase interface specifying the format used to display a string.

#Returns

Type Description
SizeF

A SizeF object that is the rectangle required to display a string.

#Remarks

The following code snippet illustrates the use of a MeasureSingleLineString method, to calculate required size of a tab stop. The tab stop position is specified by the TabInfo.Position property and measured in units of a current document (Document.Unit value). To provide uniform tab stops for a certain number of characters, a monospaced font is selected as the default document font.

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);
try
{
    for (int i = 1; i <= 30; i++)
    {
        DevExpress.XtraRichEdit.API.Native.TabInfo tab = new DevExpress.XtraRichEdit.API.Native.TabInfo();
        tab.Position = i * tabSize.Width;
        tabs.Add(tab);
    }
}
finally
{
    document.Paragraphs[0].EndUpdateTabs(tabs);
}
See Also