ImgArea_SetProperty¶

Set the value of a plug-in area property.

ImgArea_SetProperty(areaRef; propName; propValuePtr) ➔ success

areaRef	Longint	The image area reference
propName	Text	The property name.
propValuePtr	Pointer	A pointer to the variable holding the property’s value.
success	Longint	Completion status: `1` on success, `0` otherwise.

Set the value of a plug-in area property.

Parameter areaRef is the plug-in area reference.

The name of the property to be set is specified by propName.

The value of the property is in the variable pointed to by propValuePtr. The type of the variable must match that of the property. The properties defined by the plug-in area are described in the following table.

Plug-in Area Properties¶
Property name	Type	Default	Description
`SelectionVisible`	`Boolean`		`True` if the marquee selection is currently visible, `False` otherwise. Read-only.
`ZoomFactorRange`	`object`		The option’s value specifies the minimum and maximum zoom factors. See the table below for details on the object contents of this property.
`DefaultZoom`	`object`		The option’s value specifies the default zoom mode and factor when an image document is assigned to the plug-in area. See the table below for details on the object contents of this property.
`ZoomToolRate`	`Real`	`1.25`	The option’s value specifies the zoom tool rate. The zoom tool rate is the number with which the current zoom factor is multiplied when zooming in with the zoom tool. Conversely, the current zoom factor is divided by the zoom rate when zooming out.
`UseHorzScrollbar`	`Boolean`	`True`	Whether to use the horizontal scrollbar or not.
`UseVertScrollbar`	`Boolean`	`True`	Whether to use the vertical scrollbar or not.
`AutoHideScrollbars`	`Boolean`	`True`	Whether to hide the scrollbars when the displayed image size fits the usable space on the corresponding axis.
`DefaultHorzAlignment`	`Longint`	`0`	How to align the image in the display area when the image width is greater that the area width. Set to `-1` to align to the left, `0` for center, and `1` for right.
`DefaultVertAlignment`	`Longint`	`0`	How to align the image in the display area when the image height is greater that the area height. Set to `-1` to align to the top, `0` for middle, and `1` for bottom.

The contents of the ZoomFactorRange property object are described in the following table.

The `ZoomFactorRange` Object¶
Property name	Type	Default	Description
`Minimum`	`Real`	`0.02`	The option’s value specifies the minimum zoom factor of the plug-in area.
`Maximum`	`Real`	`50.0`	The option’s value specifies the maximum zoom factor of the plug-in area.

The contents of the DefaultZoom property object are described in the following table.

The `DefaultZoom` Object¶
Property name	Type	Default	Description
`ZoomFactor`	`Real`	`1.0`	The option’s value specifies the plug-in area’s default zoom factor. If the `AutoZoom` property is set to `0` or to an invalid auto-zoom mode, this zoom factor is applied to the plug-in area when a document is assigned to it.
`AutoZoom`	`Longint`	`0`	The option’s value specifies the plug-in area’s default auto-zoom mode. If set to a valid auto-zoom mode, the specified mode is applied to the plug-in area when a document is assigned to it. If set to `0` or to an invalid auto-zoom mode, the zoom factor specified with the `ZoomFactor` property is applied.

Note

In addition to the properties defined by the plug-in area, applications can attach and access custom properties to a plug-in area for their own use. The type of plug-in area properties can be any of: Boolean, Longint, Real, Text, Object, Boolean array, Longint array, Real array, Text array, Object array.

Note

This method is a convenience wrapper for the ImgArea_SetProperty_JSN plug-in method that serializes the property to JSON.