This function creates a new instance of Text annotation (HIG_ARTX_MARK_TEXT).
Declaration:
 Copy Code |
|
|---|---|
AT_ERRCOUNT ACCUAPI IG_ARTX_text_create(
LPAT_RECTANGLE pRectangle,
LPSTR lpszText,
enumIGArtXTextType nTextType,
LPAT_ARTX_FONT lpFont,
LPAT_ARTX_BORDER pBorder,
AT_INT32 nBorderShading,
LPAT_RGBQUAD pFillColor,
LPAT_RGBQUAD pTextColor,
AT_INT nOpacity,
LPAT_ARTX_PIN pTextPin,
LPAT_ARTX_CALLOUT pCallout,
LPHIG_ARTX_MARK lphMark
);
|
|
Arguments:
| Name | Type | Description |
| pRectangle | LPAT_RECTANGLE | Pointer to the annotation bounding rectangle. |
| lpszText | LPSTR | The annotation text string. |
| nTextType | enumIGArtXTextType | The annotation text type. |
| lpFont | LPAT_ARTX_FONT | Pointer to the annotation text font. |
| pBorder | LPAT_ARTX_BORDER | Pointer to the annotation border style. |
| nBorderShading | AT_INT32 | The annotation border shadow toggle. Valid values include TRUE and FALSE. |
| pFillColor | LPAT_RGBQUAD | Pointer to the annotation fill color. Specify NULL if fill color is transparent. |
| pTextColor | LPAT_RGBQUAD | Pointer to the annotation text color. Specify NULL if text color is transparent. |
| nOpacity | AT_INT | The annotation opacity. Valid values are 0 to 255. |
| pTextPin | LPAT_ARTX_PIN | Pointer to the annotation pin icon to draw over text. Specify NULL if the annotation lacks a pin. |
| pCallout | LPAT_ARTX_CALLOUT | Pointer to the annotation callout attributes. Specify NULL if the annotation lacks a callout. |
| lphMark | LPHIG_ARTX_MARK | Pointer to storage that is overwritten with the new annotation handle. |
Return Value:
Returns 0 if successful. Otherwise, returns the number of ImageGear errors that occurred during this function call.
Supported Raster Image Formats:
This function does not process image pixels.
Remarks:
Upon successful completion:
- The new annotation handle, lphMark, may be used with functions that accept either HIG_ARTX_MARK or HIG_ARTX_MARK_TEXT as input.
- The caller is responsible for deleting the newly created annotation using IG_ARTX_mark_delete.