IG_ARTX_ruler

This function creates a new instance of ruler annotation (HIG_ARTX_MARK_RULER).

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_ARTX_ruler_create( LPAT_POINT lpPoints, LPAT_ARTX_BORDER pLine, LPAT_ARTX_ASPECTRATIO lpAspectRatio, AT_INT nStartLineLength, AT_INT nEndLineLength, AT_INT nPrecision, LPSTR lpszLabel, LPAT_ARTX_FONT logFont, AT_INT nOpacity, LPHIG_ARTX_RULER lphMark );

Copy Code

AT_ERRCOUNT ACCUAPI IG_ARTX_ruler_create(
        LPAT_POINT lpPoints,    
        LPAT_ARTX_BORDER pLine,
        LPAT_ARTX_ASPECTRATIO lpAspectRatio,
        AT_INT nStartLineLength,
        AT_INT nEndLineLength,
        AT_INT nPrecision,
        LPSTR lpszLabel,
        LPAT_ARTX_FONT logFont,
        AT_INT nOpacity,
        LPHIG_ARTX_RULER lphMark
);

Arguments:

lpPoints	Array of exactly two points that define the length of the ruler: The first point is the start point. The second point is the end point.
pLine	Pointer to line style.
lpAspectRatio	Pointer to the aspect ratio.
nStartLineLength	The length of the start point touch.
nEndLineLength	The length of the end point touch.
nPrecision	The number of digits after the decimal point to report for ruler measurements.
lpszLabel	The text to label ruler measurements.
logFont	Pointer to the ruler text font.
nOpacity	The annotation opacity. Valid values are 0 to 255.
lphMark	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_RULER as input.
The caller is responsible for deleting the newly created annotation using IG_ARTX_mark_delete.

ImageGear Professional DLL v17.1 for Windows
IG_ARTX_ruler_create
Send Feedback