-
dotnet-framework-api
- C1.Win.Bitmap.4.8 Assembly
-
C1.Win.C1DX.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
C1.Util.DX.DirectWrite.TextLayout.SetDrawingEffect
SetDrawingEffect Method
SetDrawingEffect(object, TextRange)
Sets the application-defined drawing effect.
Declaration
public IntPtr SetDrawingEffect(object drawingEffect, TextRange textRange)Parameters
| Type | Name | Description |
|---|---|---|
| object | drawingEffect | Application-defined drawing effects that apply to the range. This data object will be passed back to the application's drawing callbacks for final rendering. |
| TextRange | textRange | The text range to which this change applies. |
Returns
| Type | Description |
|---|---|
| IntPtr | If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. |
Remarks
An Brush, such as a color or gradient brush, can be set as a drawing effect if you are using the RenderTarget.DrawTextLayout to draw text and that brush will be used to draw the specified range of text. This drawing effect is associated with the specified range and will be passed back to the application by way of the callback when the range is drawn at drawing time.
SetDrawingEffect(Brush, TextRange)
Sets the application-defined drawing effect.
Declaration
public void SetDrawingEffect(Brush brush, TextRange textRange)Parameters
| Type | Name | Description |
|---|---|---|
| Brush | brush | The color or gradient brush. |
| TextRange | textRange | The text range to which this change applies. |
SetDrawingEffect(IntPtr, TextRange)
HRESULT IDWriteTextLayout::SetDrawingEffect([In] void* drawingEffect,[In] DWRITE_TEXT_RANGE textRange)
Declaration
public void SetDrawingEffect(IntPtr drawingEffect, TextRange textRange)Parameters
| Type | Name | Description |
|---|---|---|
| IntPtr | drawingEffect | |
| TextRange | textRange |