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 ConstructorInitializes a new instance of the TextLayout class.  
    Top
    Public Properties
     NameDescription
    Public PropertyGets a copy of the font family name. (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public PropertyGets a value indicating whether this instance is disposed. (Inherited from C1.Util.DX.DisposeBase)
    Public PropertyGets a copy of the locale name. (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public PropertyGetMetrics  
    Public PropertyGet a pointer to the underlying Cpp Object (Inherited from C1.Util.DX.CppObject)
    Public PropertyGetOverhangMetrics  
    Public PropertyGets 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)Overloaded. Takes a string, text format, and associated constraints, and produces an object that represents the fully analyzed and formatted result.  
    Public MethodHRESULT IDWriteTextLayout::DetermineMinWidth([Out] float* minWidth)  
    Public MethodOverloaded. Clean up any resources being used. (Inherited from C1.Util.DX.ComObject)
    Public MethodOverloaded. Draws text using the specified client drawing context.  
    Public MethodOverloaded. Retrieves logical properties and measurements of each glyph cluster.  
    Public MethodOverloaded. Gets the application-defined drawing effect at the specified text position.  
    Public MethodDWRITE_FLOW_DIRECTION IDWriteTextFormat::GetFlowDirection() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodOverloaded. Gets the font collection associated with the text at the specified position.  
    Public MethodOverloaded. Gets the font family name of the text at the specified position.  
    Public MethodOverloaded. HRESULT IDWriteTextLayout::GetFontFamilyNameLength([In] unsigned int currentPosition,[Out] unsigned int* nameLength,[Out, Optional] DWRITE_TEXT_RANGE* textRange)  
    Public MethodOverloaded. Gets the font em height of the text at the specified position.  
    Public MethodOverloaded. Gets the font stretch of the text at the specified position.  
    Public MethodOverloaded. Gets the font style (also known as slope) of the text at the specified position.  
    Public MethodOverloaded. Gets the font weight of the text at the specified position.  
    Public Methodfloat IDWriteTextFormat::GetIncrementalTabStop() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodOverloaded. Gets the inline object at the specified position.  
    Public MethodOverloaded. Retrieves the information about each individual text line of the text string.  
    Public MethodHRESULT IDWriteTextFormat::GetLineSpacing([Out] DWRITE_LINE_SPACING_METHOD* lineSpacingMethod,[Out] float* lineSpacing,[Out] float* baseline) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodOverloaded. Gets the locale name of the text at the specified position.  
    Public MethodOverloaded. HRESULT IDWriteTextLayout::GetLocaleNameLength([In] unsigned int currentPosition,[Out] unsigned int* nameLength,[Out, Optional] DWRITE_TEXT_RANGE* textRange)  
    Public Methodfloat IDWriteTextLayout::GetMaxHeight()  
    Public Methodfloat IDWriteTextLayout::GetMaxWidth()  
    Public MethodHRESULT IDWriteTextLayout::GetMetrics([Out] DWRITE_TEXT_METRICS* textMetrics)  
    Public MethodHRESULT IDWriteTextLayout::GetOverhangMetrics([Out] DWRITE_OVERHANG_METRICS* overhangs)  
    Public MethodDWRITE_PARAGRAPH_ALIGNMENT IDWriteTextFormat::GetParagraphAlignment() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodDWRITE_READING_DIRECTION IDWriteTextFormat::GetReadingDirection() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodDWRITE_TEXT_ALIGNMENT IDWriteTextFormat::GetTextAlignment() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodHRESULT IDWriteTextFormat::GetTrimming([Out] DWRITE_TRIMMING* trimmingOptions,[Out] IDWriteInlineObject** trimmingSign) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodOverloaded. Gets the typography setting of the text at the specified position.  
    Public MethodDWRITE_WORD_WRAPPING IDWriteTextFormat::GetWordWrapping() (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodOverloaded. Get the strikethrough presence of the text at the specified position.  
    Public MethodOverloaded. Gets the underline presence of the text at the specified position.  
    Public MethodHRESULT IDWriteTextLayout::HitTestPoint([In] float pointX,[In] float pointY,[Out] BOOL* isTrailingHit,[Out] BOOL* isInside,[Out] DWRITE_HIT_TEST_METRICS* hitTestMetrics)  
    Public MethodHRESULT IDWriteTextLayout::HitTestTextPosition([In] unsigned int textPosition,[In] BOOL isTrailingHit,[Out] float* pointX,[Out] float* pointY,[Out] DWRITE_HIT_TEST_METRICS* hitTestMetrics)  
    Public MethodOverloaded. 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 MethodOverloaded. Query this instance for a particular COM GUID/interface support. (Inherited from C1.Util.DX.ComObject)
    Public MethodOverloaded. Query instance for a particular COM GUID/interface support. (Inherited from C1.Util.DX.ComObject)
    Public MethodOverloaded. Sets the application-defined drawing effect.  
    Public MethodHRESULT IDWriteTextFormat::SetFlowDirection([In] DWRITE_FLOW_DIRECTION flowDirection) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodHRESULT IDWriteTextLayout::SetFontCollection([In] IDWriteFontCollection* fontCollection,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodHRESULT IDWriteTextLayout::SetFontFamilyName([In] const wchar_t* fontFamilyName,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodHRESULT IDWriteTextLayout::SetFontSize([In] float fontSize,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodHRESULT IDWriteTextLayout::SetFontStretch([In] DWRITE_FONT_STRETCH fontStretch,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodHRESULT IDWriteTextLayout::SetFontStyle([In] DWRITE_FONT_STYLE fontStyle,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodHRESULT IDWriteTextLayout::SetFontWeight([In] DWRITE_FONT_WEIGHT fontWeight,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodHRESULT IDWriteTextFormat::SetIncrementalTabStop([In] float incrementalTabStop) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodSets the inline object.  
    Public MethodHRESULT IDWriteTextFormat::SetLineSpacing([In] DWRITE_LINE_SPACING_METHOD lineSpacingMethod,[In] float lineSpacing,[In] float baseline) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodHRESULT IDWriteTextLayout::SetLocaleName([In] const wchar_t* localeName,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodHRESULT IDWriteTextLayout::SetMaxHeight([In] float maxHeight)  
    Public MethodHRESULT IDWriteTextLayout::SetMaxWidth([In] float maxWidth)  
    Public MethodHRESULT IDWriteTextFormat::SetParagraphAlignment([In] DWRITE_PARAGRAPH_ALIGNMENT paragraphAlignment) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodHRESULT IDWriteTextFormat::SetReadingDirection([In] DWRITE_READING_DIRECTION readingDirection) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodHRESULT IDWriteTextLayout::SetStrikethrough([In] BOOL hasStrikethrough,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodHRESULT IDWriteTextFormat::SetTextAlignment([In] DWRITE_TEXT_ALIGNMENT textAlignment) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public Method

    Sets trimming options for text overflowing the layout width.

    (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Public MethodHRESULT IDWriteTextLayout::SetTypography([In] IDWriteTypography* typography,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodHRESULT IDWriteTextLayout::SetUnderline([In] BOOL hasUnderline,[In] DWRITE_TEXT_RANGE textRange)  
    Public MethodHRESULT IDWriteTextFormat::SetWordWrapping([In] DWRITE_WORD_WRAPPING wordWrapping) (Inherited from C1.Util.DX.DirectWrite.TextFormat)
    Top
    Protected Methods
     NameDescription
    Protected MethodReleases 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 MethodOverloaded. 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 MethodMethod called when the NativePointer is updated. (Inherited from C1.Util.DX.ComObject)
    Protected MethodMethod called when NativePointer is going to be update. (Inherited from C1.Util.DX.ComObject)
    Protected MethodQuery Interface for a particular interface support and attach to the given instance. (Inherited from C1.Util.DX.ComObject)
    Top
    Public Events
     NameDescription
    Public EventOccurs when this instance is fully disposed. (Inherited from C1.Util.DX.DisposeBase)
    Public EventOccurs when this instance is starting to be disposed. (Inherited from C1.Util.DX.DisposeBase)
    Top
    Public Operators
    Performs an explicit conversion from System.IntPtr to TextLayout.
    Top
    See Also