ReadWriteBitmapDataExtensionsDrawText(IReadWriteBitmapData, Brush, String, Font, RectangleF, StringFormat, DrawingOptions, ParallelConfig) Method
Draws a text, filling the characters with the specified
Brush.
Namespace: KGySoft.Drawing.ImagingAssembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 10.0.0-rc.1
public static bool DrawText(
this IReadWriteBitmapData bitmapData,
Brush brush,
string text,
Font font,
RectangleF bounds,
StringFormat? format = null,
DrawingOptions? drawingOptions = null,
ParallelConfig? parallelConfig = null
)
<ExtensionAttribute>
Public Shared Function DrawText (
bitmapData As IReadWriteBitmapData,
brush As Brush,
text As String,
font As Font,
bounds As RectangleF,
Optional format As StringFormat = Nothing,
Optional drawingOptions As DrawingOptions = Nothing,
Optional parallelConfig As ParallelConfig = Nothing
) As Boolean
public:
[ExtensionAttribute]
static bool DrawText(
IReadWriteBitmapData^ bitmapData,
Brush^ brush,
String^ text,
Font^ font,
RectangleF bounds,
StringFormat^ format = nullptr,
DrawingOptions^ drawingOptions = nullptr,
ParallelConfig^ parallelConfig = nullptr
)
[<ExtensionAttribute>]
static member DrawText :
bitmapData : IReadWriteBitmapData *
brush : Brush *
text : string *
font : Font *
bounds : RectangleF *
?format : StringFormat *
?drawingOptions : DrawingOptions *
?parallelConfig : ParallelConfig
(* Defaults:
let _format = defaultArg format null
let _drawingOptions = defaultArg drawingOptions null
let _parallelConfig = defaultArg parallelConfig null
*)
-> bool
- bitmapData IReadWriteBitmapData
- The IReadWriteBitmapData instance to draw on.
- brush Brush
- The Brush to draw the text with.
- text String
- A string that represents the text to draw.
- font Font
- The Font that defines the typeface, size, and style of the text.
- bounds RectangleF
- The bounding rectangle that specifies the size and location the text should fit into, not counting the width of the outline.
- format StringFormat (Optional)
- A StringFormat instance that specifies text formatting information, such as line spacing and alignment.
- drawingOptions DrawingOptions (Optional)
- A DrawingOptions instance that specifies the drawing options to use. If , then the default options are used. This parameter is optional.
Default value: . - parallelConfig ParallelConfig (Optional)
- The configuration of the operation such as parallelization, cancellation, reporting progress, etc.
When Progress is set in this parameter,
then this library always passes a DrawingOperation instance to the generic methods of
the IAsyncProgress interface.
If , then the degree of parallelization is configured automatically. This parameter is optional.
Default value: .
Boolean, if the operation completed successfully.
, if the operation has been canceled and the
ThrowIfCanceled property
of the
parallelConfig parameter was
. This parameter is optional.
Default value:
.In Visual Basic and C#, you can call this method as an instance method on any object of type
IReadWriteBitmapData. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
This method fills the characters of the text. To draw the outline of a text, you can use the DrawTextOutline methods.
To draw a text with both filled and outlined characters, instead of calling
DrawText
and
DrawTextOutline consecutively, you can achieve a better performance by creating a
Path once, and then calling
the
FillPath and
DrawPath methods.
You can convert the specified
text to a
Path by using the
GraphicsPath.AddString and
GraphicsPathExtensions.ToPath methods.
If you draw the text without antialiasing, it is recommended to set the
FastThinLines to
in
drawingOptions
so the outline correctly aligns to the filled area.
When AntiAliasing is set in drawingOptions and you use non-monochromatic colors, it is recommended to specify Linear
color space when you obtain the IReadWriteBitmapData instance, especially for small fonts; otherwise, the quality of the drawn text can be poor if alpha colors are blended in the sRGB color space.
See more details at the Examples section of the WorkingColorSpace enumeration.
This method blocks the caller as it executes synchronously, though the
parallelConfig parameter allows configuring the degree of parallelism, cancellation and progress reporting. Use
the
BeginDrawText or
DrawTextAsync
(in .NET Framework 4.0 and above) methods to perform the operation asynchronously.
