ImageGear for C and C++ on Linux v18.8 - Updated
ART_control_option_set
API Reference Guide > ART Component API Reference > ART Component Functions Reference > Control Functions > ART_control_option_set

This function modifies default library settings that changes the default behavior of the library.

Declaration:

 
Copy Code 
AT_ERRCOUNT ART_control_option_set(
        HIGEAR hIGear, 
        AT_MODE nOption, 
        const LPVOID lpValue
);

Arguments:

Name Type Description
hIGear HIGEAR HIGEAR handle of an image.
nOption AT_MODE An ART-defined constant for the Library option to change.
lpValue const LPVOID A far pointer to a new value for the option.

Return Value:

Returns the number of ImageGear errors that occurred during the function call.

Supported Raster Image Formats:

All pixel formats supported by ImageGear for C and C++.

Example:

 
Copy Code 
HIGEAR hIGear; /* HIGEAR handle of image */
nErrcount = ART_control_option_set(hIGear, 
ART_CONTROL_SHOW_LOCKS, TRUE);

Remarks:

nOption specifies the option to set. The following list describes the available options and their default values:

Option Type Default Description
ART_CONTROL_CLIP_TEXT BOOL TRUE Text marks are clipped if they do not fit within the bounds of the annotation.
ART_CONTROL_CREATE_SCROLL BOOL FALSE Does auto scrolling for the zoomed image when annotation is created. Applicable for Filled Rectangle, Hollow Rectangle, Highlighter, Typed Text, Attach-a-Note, RTF text, Text file, Text Stamp, Hot Spot, Redaction, Button, Encryption, Filled Ellipse, and Hollow Ellipse marks.
ART_CONTROL_DISABLE_CLIPPING BOOL FALSE Disables clipping.
ART_CONTROL_DISABLE_PPM_FOR_FONTS BOOL FALSE Disables PPM in font size calculations. If TRUE, tells ImageGear to ignore the image resolution when displaying text annotations. See also description of ART_MARK_ATTRIBUTES structure and ART_DISABLE_PPM_FOR_FONTS_GET/ART_DISABLE_PPM_FOR_FONTS_SET macros.
ART_CONTROL_DO_NOT_MODIFY_CURSOR BOOL FALSE Disables cursor modifications.
ART_CONTROL_ENABLE_SELECTION_UNDO BOOL TRUE If this option is set to FALSE, the selections are not placed in undo stack.
ART_CONTROL_FULL_TEXTMARKS_SELECT BOOL FALSE If TRUE, enables selecting a text mark using a mouse click when the text is not visible.
ART_CONTROL_LARGEFONTS_ENABLE BOOL FALSE If TRUE, then the use of very large fonts are enabled for text marks.
ART_CONTROL_LOAD_ORIENTATION BOOL TRUE Enables loading an annotation with or without orientation.
ART_CONTROL_PRINT_ENABLE BOOL TRUE Enables printing of marks with the image.
ART_CONTROL_RECT_SELECTION BOOL TRUE Indicates the selection width of the rectangle around the mark.
ART_CONTROL_SAVE_ENABLE BOOL TRUE Enables saving of marks as an embedded file with a TIFF image.
ART_CONTROL_SAVE_ORIENTATION BOOL TRUE Enables saving an annotation with or without orientation.
ART_CONTROL_SELECT_NO_CLIP BOOL FALSE Ignores clipping during selection.
ART_CONTROL_SELECT_SCROLL BOOL FALSE Scroll and select at the same time.
ART_CONTROL_SHADOW_FONTS BOOL FALSE Enables shadow fonts.
ART_CONTROL_SHOW_LOCKS BOOL FALSE Whether to show padlocks on marks that have access locked.
ART_CONTROL_SHOW_TEXT_WARNING BOOL FALSE Whether to show warning text or not.
ART_CONTROL_TEXT_WARNING_MSG LPSTR Default message string Specifies the warning text string shown if ART_CONTROL_SHOW_TEXT_WARNING is set to TRUE.
ART_CONTROL_UNIX_LEGACY_FONTS_LOAD BOOL FALSE Enables/disables legacy X font creation for all text marks. See also ART_UNIX_LEGACY_FONTS_LOAD_GET and ART_UNIX_LEGACY_FONTS_LOAD_SET.
ART_CONTROL_USE_ONE_AS_FALSE BOOL FALSE Enables using 1 as FALSE value.
ART_CONTROL_WANG_LOAD_COMPATIBILITY BOOL FALSE Disables Wang compatibility for load.
ART_CONTROL_WANG_SAVE_COMPATIBILITY BOOL FALSE Disables Wang compatibility for save.

 

 

©2020. Accusoft Corporation. All Rights Reserved.

Send Feedback