-
dotnet-framework-api
- C1.Win.Bitmap.4.8 Assembly
-
C1.Win.DX.4.8 Assembly
- C1.Util.DX
- C1.Util.DX.Animation
- C1.Util.DX.DXGI
- C1.Util.DX.Direct2D
- C1.Util.DX.Direct2D.Effects
- C1.Util.DX.Direct3D11
-
C1.Util.DX.DirectWrite
-
Classes
- BitmapRenderTarget
- BitmapRenderTarget1
- ColorGlyphRun
- ColorGlyphRunEnumerator
- DWrite
- EllipsisTrimming
- Factory
- Factory1
- Factory2
- Font
- Font1
- FontCollection
- FontCollectionLoaderShadow
- FontFace
- FontFace1
- FontFallback
- FontFallbackBuilder
- FontFamily
- FontFile
- FontFileEnumeratorShadow
- FontFileLoaderNative
- FontFileLoaderShadow
- FontFileStreamNative
- FontFileStreamShadow
- FontList
- GdiInterop
- GlyphRun
- GlyphRunAnalysis
- GlyphRunDescription
- InlineObjectNative
- InlineObjectShadow
- LocalFontFileLoader
- LocalizedStrings
- LogFont
- NumberSubstitution
- PixelSnappingShadow
- RenderingParams
- RenderingParams1
- RenderingParams2
- ResultCode
- TextAnalysisQuickSink1Shadow
- TextAnalysisQuickSinkShadow
- TextAnalysisQuickSource1Shadow
- TextAnalysisQuickSourceShadow
- TextAnalysisSink1Shadow
- TextAnalysisSinkShadow
- TextAnalysisSource1Shadow
- TextAnalysisSourceShadow
- TextAnalyzer
- TextAnalyzer1
- TextFormat
-
TextLayout
- Constructors
- Properties
-
Methods
- Create
- DetermineMinWidth
- Draw
- GetClusterMetrics
- GetDrawingEffect
- GetFontCollection
- GetFontFamilyName
- GetFontFamilyNameLength
- GetFontSize
- GetFontStretch
- GetFontStyle
- GetFontWeight
- GetInlineObject
- GetLineMetrics
- GetLocaleName
- GetLocaleNameLength
- GetMaxHeight
- GetMaxWidth
- GetMetrics
- GetOverhangMetrics
- GetTypography
- HasStrikethrough
- HasUnderline
- HitTestPoint
- HitTestTextPosition
- HitTestTextRange
- SetDrawingEffect
- SetFontCollection
- SetFontFamilyName
- SetFontSize
- SetFontStretch
- SetFontStyle
- SetFontWeight
- SetInlineObject
- SetLocaleName
- SetMaxHeight
- SetMaxWidth
- SetStrikethrough
- SetTypography
- SetUnderline
- Operators
- TextLayout1
- TextRenderer1Base
- TextRenderer1Shadow
- TextRendererBase
- TextRendererShadow
- Typography
- Structs
- Enums
- Interfaces
-
Classes
- C1.Util.DX.Storage
- C1.Util.DX.WIC
- dotnet-api
C1.Util.DX.DirectWrite.TextLayout.HitTestTextRange
HitTestTextRange Method
HitTestTextRange(int, int, float, float)
The application calls this function to get a set of hit-test metrics corresponding to a range of text positions. One of the main usages is to implement highlight selection of the text string. The function returns E_NOT_SUFFICIENT_BUFFER, which is equivalent to HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER), when the buffer size of hitTestMetrics is too small to hold all the regions calculated by the function. In this situation, the function sets the output value *actualHitTestMetricsCount to the number of geometries calculated. The application is responsible for allocating a new buffer of greater size and calling the function again. A good value to use as an initial value for maxHitTestMetricsCount may be calculated from the following equation: maxHitTestMetricsCount = lineCount * maxBidiReorderingDepth where lineCount is obtained from the value of the output argument *actualLineCount (from the function IDWriteTextLayout::GetLineLengths), and the maxBidiReorderingDepth value from the DWRITE_TEXT_METRICS structure of the output argument *textMetrics (from the function IDWriteFactory::CreateTextLayout).
Declaration
public HitTestMetrics[] HitTestTextRange(int textPosition, int textLength, float originX, float originY)Public Function HitTestTextRange(textPosition As Integer, textLength As Integer, originX As Single, originY As Single) As HitTestMetrics()Parameters
| Type | Name | Description |
|---|---|---|
| int | textPosition | The first text position of the specified range. |
| int | textLength | The number of positions of the specified range. |
| float | originX | The origin pixel location X at the left of the layout box. This offset is added to the hit-test metrics returned. |
| float | originY | The origin pixel location Y at the top of the layout box. This offset is added to the hit-test metrics returned. |
Returns
| Type | Description |
|---|---|
| HitTestMetrics[] | a reference to a buffer of the output geometry fully enclosing the specified position range. The buffer must be at least as large as maxHitTestMetricsCount. |
HitTestTextRange(int, int, float, float, HitTestMetrics[], int, out int)
HRESULT IDWriteTextLayout::HitTestTextRange([In] unsigned int textPosition,[In] unsigned int textLength,[In] float originX,[In] float originY,[Out, Buffer, Optional] DWRITE_HIT_TEST_METRICS* hitTestMetrics,[In] unsigned int maxHitTestMetricsCount,[Out] unsigned int* actualHitTestMetricsCount)
Declaration
public HResult HitTestTextRange(int textPosition, int textLength, float originX, float originY, HitTestMetrics[] hitTestMetrics, int maxHitTestMetricsCount, out int actualHitTestMetricsCount)Public Function HitTestTextRange(textPosition As Integer, textLength As Integer, originX As Single, originY As Single, hitTestMetrics As HitTestMetrics(), maxHitTestMetricsCount As Integer, ByRef actualHitTestMetricsCount As Integer) As HResultParameters
| Type | Name | Description |
|---|---|---|
| int | textPosition | |
| int | textLength | |
| float | originX | |
| float | originY | |
| HitTestMetrics[] | hitTestMetrics | |
| int | maxHitTestMetricsCount | |
| int | actualHitTestMetricsCount |
Returns
| Type | Description |
|---|---|
| HResult |