ReadWriteBitmapDataExtensionsBeginDrawText(IReadWriteBitmapData, Color32, String, Font, PointF, StringFormat, DrawingOptions, AsyncConfig) Method
Begins to draw a text, filling the characters with a solid brush of the specified color.
Namespace: KGySoft.Drawing.ImagingAssembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 10.0.0-rc.1
public static IAsyncResult BeginDrawText(
this IReadWriteBitmapData bitmapData,
Color32 color,
string text,
Font font,
PointF location,
StringFormat? format = null,
DrawingOptions? drawingOptions = null,
AsyncConfig? asyncConfig = null
)
<ExtensionAttribute>
Public Shared Function BeginDrawText (
bitmapData As IReadWriteBitmapData,
color As Color32,
text As String,
font As Font,
location As PointF,
Optional format As StringFormat = Nothing,
Optional drawingOptions As DrawingOptions = Nothing,
Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult
public:
[ExtensionAttribute]
static IAsyncResult^ BeginDrawText(
IReadWriteBitmapData^ bitmapData,
Color32 color,
String^ text,
Font^ font,
PointF location,
StringFormat^ format = nullptr,
DrawingOptions^ drawingOptions = nullptr,
AsyncConfig^ asyncConfig = nullptr
)
[<ExtensionAttribute>]
static member BeginDrawText :
bitmapData : IReadWriteBitmapData *
color : Color32 *
text : string *
font : Font *
location : PointF *
?format : StringFormat *
?drawingOptions : DrawingOptions *
?asyncConfig : AsyncConfig
(* Defaults:
let _format = defaultArg format null
let _drawingOptions = defaultArg drawingOptions null
let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult
- bitmapData IReadWriteBitmapData
- The IReadWriteBitmapData instance to draw on.
- color Color32
- The color of the solid 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.
- location PointF
- The location of the upper-left corner of the text's bounding rectangle.
- format StringFormat (Optional)
- A StringFormat instance that specifies text formatting information, such as line spacing and alignment. This parameter is optional.
Default value: . - 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: . - asyncConfig AsyncConfig (Optional)
- The configuration of the asynchronous 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. This parameter is optional.
Default value: .
IAsyncResultAn
IAsyncResult that represents the asynchronous operation, which could still be pending.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 BeginDrawTextOutline methods.
To draw a text with both filled and outlined characters, instead of calling
BeginDrawText
and
BeginDrawTextOutline consecutively, you can achieve a better performance by creating a
Path once, and then calling
the
BeginFillPath and
BeginDrawPath 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.
In .NET Framework 4.0 and above you can use also the DrawTextAsync methods.
To finish the operation and to get the exception that occurred during the operation you have to call the EndDrawText method.
This method is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.
