ComponentOne Bitmap for WinForms
C1.Win.C1DX.4.8 Assembly / C1.Util.DX.DirectWrite Namespace / TextLayout Class
Properties Methods Events


In This Topic
    TextLayout Class Members
    In This Topic

    The following tables list the members exposed by TextLayout.

    Public Constructors
     NameDescription
    Public ConstructorTextLayout ConstructorInitializes a new instance of the TextLayout class.  
    Top
    Public Properties
     NameDescription
    Public PropertyFontFamilyNameGets a copy of the font family name. (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public PropertyIsDisposedGets a value indicating whether this instance is disposed. (Inherited from C1.Util.DX.DisposeBase)
    Public PropertyLocaleNameGets a copy of the locale name. (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public PropertyMetricsGetMetrics  
    Public PropertyNativePointerGet a pointer to the underlying Cpp Object (Inherited from C1.Util.DX.CppObject)
    Public PropertyOverhangMetricsGetOverhangMetrics  
    Public PropertyTagGets or sets a custom user tag object to associate with this instance.. (Inherited from C1.Util.DX.CppObject)
    Top
    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic)CreateOverloaded. Takes a string, text format, and associated constraints, and produces an object that represents the fully analyzed and formatted result.  
    Public MethodDetermineMinWidthHRESULT IDWriteTextLayout::DetermineMinWidth([Out] float* minWidth)  
    Public MethodDisposeOverloaded. Clean up any resources being used. (Inherited from C1.Util.DX.ComObject)
    Public MethodDrawOverloaded. Draws text using the specified client drawing context.  
    Public MethodGetClusterMetricsOverloaded. Retrieves logical properties and measurements of each glyph cluster.  
    Public MethodGetDrawingEffectOverloaded. Gets the application-defined drawing effect at the specified text position.  
    Public MethodGetFlowDirectionDWRITE_FLOW_DIRECTION IDWriteTextFormat::GetFlowDirection() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodGetFontCollectionOverloaded. Gets the font collection associated with the text at the specified position.  
    Public MethodGetFontFamilyNameOverloaded. Gets the font family name of the text at the specified position.  
    Public MethodGetFontFamilyNameLengthOverloaded. HRESULT IDWriteTextLayout::GetFontFamilyNameLength([In] unsigned int currentPosition,[Out] unsigned int* nameLength,[Out, Optional] DWRITE_TEXT_RANGE* textRange)  
    Public MethodGetFontSizeOverloaded. Gets the font em height of the text at the specified position.  
    Public MethodGetFontStretchOverloaded. Gets the font stretch of the text at the specified position.  
    Public MethodGetFontStyleOverloaded. Gets the font style (also known as slope) of the text at the specified position.  
    Public MethodGetFontWeightOverloaded. Gets the font weight of the text at the specified position.  
    Public MethodGetIncrementalTabStopfloat IDWriteTextFormat::GetIncrementalTabStop() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodGetInlineObjectOverloaded. Gets the inline object at the specified position.  
    Public MethodGetLineMetricsOverloaded. Retrieves the information about each individual text line of the text string.  
    Public MethodGetLineSpacingHRESULT IDWriteTextFormat::GetLineSpacing([Out] DWRITE_LINE_SPACING_METHOD* lineSpacingMethod,[Out] float* lineSpacing,[Out] float* baseline) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodGetLocaleNameOverloaded. Gets the locale name of the text at the specified position.  
    Public MethodGetLocaleNameLengthOverloaded. HRESULT IDWriteTextLayout::GetLocaleNameLength([In] unsigned int currentPosition,[Out] unsigned int* nameLength,[Out, Optional] DWRITE_TEXT_RANGE* textRange)  
    Public MethodGetMaxHeightfloat IDWriteTextLayout::GetMaxHeight()  
    Public MethodGetMaxWidthfloat IDWriteTextLayout::GetMaxWidth()  
    Public MethodGetMetricsHRESULT IDWriteTextLayout::GetMetrics([Out] DWRITE_TEXT_METRICS* textMetrics)  
    Public MethodGetOverhangMetricsHRESULT IDWriteTextLayout::GetOverhangMetrics([Out] DWRITE_OVERHANG_METRICS* overhangs)  
    Public MethodGetParagraphAlignmentDWRITE_PARAGRAPH_ALIGNMENT IDWriteTextFormat::GetParagraphAlignment() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodGetReadingDirectionDWRITE_READING_DIRECTION IDWriteTextFormat::GetReadingDirection() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodGetTextAlignmentDWRITE_TEXT_ALIGNMENT IDWriteTextFormat::GetTextAlignment() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodGetTrimmingHRESULT IDWriteTextFormat::GetTrimming([Out] DWRITE_TRIMMING* trimmingOptions,[Out] IDWriteInlineObject** trimmingSign) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodGetTypographyOverloaded. Gets the typography setting of the text at the specified position.  
    Public MethodGetWordWrappingDWRITE_WORD_WRAPPING IDWriteTextFormat::GetWordWrapping() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodHasStrikethroughOverloaded. Get the strikethrough presence of the text at the specified position.  
    Public MethodHasUnderlineOverloaded. Gets the underline presence of the text at the specified position.  
    Public MethodHitTestPointHRESULT IDWriteTextLayout::HitTestPoint([In] float pointX,[In] float pointY,[Out] BOOL* isTrailingHit,[Out] BOOL* isInside,[Out] DWRITE_HIT_TEST_METRICS* hitTestMetrics)  
    Public MethodHitTestTextPositionHRESULT IDWriteTextLayout::HitTestTextPosition([In] unsigned int textPosition,[In] BOOL isTrailingHit,[Out] float* pointX,[Out] float* pointY,[Out] DWRITE_HIT_TEST_METRICS* hitTestMetrics)  
    Public MethodHitTestTextRangeOverloaded. 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).  
    Public MethodQueryInterfaceOverloaded. Query this instance for a particular COM GUID/interface support. (Inherited from C1.Util.DX.ComObject)
    Public MethodQueryInterfaceOrNullOverloaded. Query instance for a particular COM GUID/interface support. (Inherited from C1.Util.DX.ComObject)
    Public MethodSetDrawingEffectOverloaded. Sets the application-defined drawing effect.  
    Public MethodSetFlowDirectionHRESULT IDWriteTextFormat::SetFlowDirection([In] DWRITE_FLOW_DIRECTION flowDirection) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodSetFontCollectionHRESULT IDWriteTextLayout::SetFontCollection([In] IDWriteFontCollection* fontCollection,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodSetFontFamilyNameHRESULT IDWriteTextLayout::SetFontFamilyName([In] const wchar_t* fontFamilyName,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodSetFontSizeHRESULT IDWriteTextLayout::SetFontSize([In] float fontSize,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodSetFontStretchHRESULT IDWriteTextLayout::SetFontStretch([In] DWRITE_FONT_STRETCH fontStretch,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodSetFontStyleHRESULT IDWriteTextLayout::SetFontStyle([In] DWRITE_FONT_STYLE fontStyle,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodSetFontWeightHRESULT IDWriteTextLayout::SetFontWeight([In] DWRITE_FONT_WEIGHT fontWeight,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodSetIncrementalTabStopHRESULT IDWriteTextFormat::SetIncrementalTabStop([In] float incrementalTabStop) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodSetInlineObjectSets the inline object.  
    Public MethodSetLineSpacingHRESULT IDWriteTextFormat::SetLineSpacing([In] DWRITE_LINE_SPACING_METHOD lineSpacingMethod,[In] float lineSpacing,[In] float baseline) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodSetLocaleNameHRESULT IDWriteTextLayout::SetLocaleName([In] const wchar_t* localeName,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodSetMaxHeightHRESULT IDWriteTextLayout::SetMaxHeight([In] float maxHeight)  
    Public MethodSetMaxWidthHRESULT IDWriteTextLayout::SetMaxWidth([In] float maxWidth)  
    Public MethodSetParagraphAlignmentHRESULT IDWriteTextFormat::SetParagraphAlignment([In] DWRITE_PARAGRAPH_ALIGNMENT paragraphAlignment) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodSetReadingDirectionHRESULT IDWriteTextFormat::SetReadingDirection([In] DWRITE_READING_DIRECTION readingDirection) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodSetStrikethroughHRESULT IDWriteTextLayout::SetStrikethrough([In] BOOL hasStrikethrough,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodSetTextAlignmentHRESULT IDWriteTextFormat::SetTextAlignment([In] DWRITE_TEXT_ALIGNMENT textAlignment) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodSetTrimming

    Sets trimming options for text overflowing the layout width.

    (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodSetTypographyHRESULT IDWriteTextLayout::SetTypography([In] IDWriteTypography* typography,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodSetUnderlineHRESULT IDWriteTextLayout::SetUnderline([In] BOOL hasUnderline,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodSetWordWrappingHRESULT IDWriteTextFormat::SetWordWrapping([In] DWRITE_WORD_WRAPPING wordWrapping) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Top
    Protected Methods
     NameDescription
    Protected MethodFinalizeReleases unmanaged resources and performs other cleanup operations before the C1.Util.DX.DisposeBase is reclaimed by garbage collection. (Inherited from C1.Util.DX.DisposeBase)
    Protected MethodFromTempOverloaded. Initializes this instance with a pointer from a temporary object and set the pointer of the temporary object to IntPtr.Zero. (Inherited from C1.Util.DX.CppObject)
    Protected MethodNativePointerUpdatedMethod called when the NativePointer is updated. (Inherited from C1.Util.DX.ComObject)
    Protected MethodNativePointerUpdatingMethod called when NativePointer is going to be update. (Inherited from C1.Util.DX.ComObject)
    Protected MethodQueryInterfaceFrom<T>Query Interface for a particular interface support and attach to the given instance. (Inherited from C1.Util.DX.ComObject)
    Top
    Public Events
     NameDescription
    Public EventDisposedOccurs when this instance is fully disposed. (Inherited from C1.Util.DX.DisposeBase)
    Public EventDisposingOccurs when this instance is starting to be disposed. (Inherited from C1.Util.DX.DisposeBase)
    Top
    Public Operators
    public Operator Explicit Type Conversion Performs an explicit conversion from System.IntPtr to TextLayout.
    Top
    See Also

    Reference

    TextLayout Class
    C1.Util.DX.DirectWrite Namespace