TextSource.GetPrecedingText(Int32) Method

Reference

Definition

Namespace:: System.Windows.Media.TextFormatting

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Retrieves the text span immediately before the specified TextSource position.

public:
 abstract System::Windows::Media::TextFormatting::TextSpan<System::Windows::Media::TextFormatting::CultureSpecificCharacterBufferRange ^> ^ GetPrecedingText(int textSourceCharacterIndexLimit);

public abstract System.Windows.Media.TextFormatting.TextSpan<System.Windows.Media.TextFormatting.CultureSpecificCharacterBufferRange> GetPrecedingText (int textSourceCharacterIndexLimit);

abstract member GetPrecedingText : int -> System.Windows.Media.TextFormatting.TextSpan<System.Windows.Media.TextFormatting.CultureSpecificCharacterBufferRange>

Public MustOverride Function GetPrecedingText (textSourceCharacterIndexLimit As Integer) As TextSpan(Of CultureSpecificCharacterBufferRange)

Parameters

textSourceCharacterIndexLimit: Int32

The character index position where text retrieval stops.

Returns

TextSpan<CultureSpecificCharacterBufferRange>

A CultureSpecificCharacterBufferRange value that represents the text span immediately before textSourceCharacterIndexLimit.

Remarks

The GetPrecedingText method returns an empty CultureSpecificCharacterBufferRange if the text span immediately before textSourceCharacterIndexLimit does not contain any text, such as inline object or a hidden run.

This method returns a zero-length text span if there are no values preceding textSourceCharacterIndexLimit.

Applies to