RichEditControl.MeasureSingleLineString(String, CharacterPropertiesBase) Method
Calculates the length of a formatted string.
Namespace: DevExpress.Xpf.RichEdit
Assembly: DevExpress.Xpf.RichEdit.v20.2.dll
NuGet Packages: DevExpress.WindowsDesktop.Wpf.RichEdit, DevExpress.Wpf.RichEdit
Declaration
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.
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)
Try
For i As Integer = 1 To 30
Dim tab As New DevExpress.XtraRichEdit.API.Native.TabInfo()
tab.Position = i * tabSize.Width
tabs.Add(tab)
Next i
Finally
document.Paragraphs(0).EndUpdateTabs(tabs)
End Try