Sheet.customSize Property

This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

Gets or sets the custom sheet dimensions and border zones for this sheet.

When getting: returns a new CustomSheetSize with the current layout width, height, and border zone counts. This is provided for standard sheet sizes as well as custom sizes so callers can read dimensions, adjust them, and assign the object back. When setting: applies width, height, and zones and persists a custom sheet size for this sheet. The value must not be null.

Width and height use the document drawing units (millimeters or inches), as reported by DocumentSettings.units. Validation limits are described on CustomSheetSize. If both horizontalZones and verticalZones are zero on set, existing border zone counts on the sheet are left unchanged (so scripts can change only width and height).

Syntax

# Get the value of the property.
propertyValue = sheet_var.customSize

# Set the value of the property.
sheet_var.customSize = propertyValue

#include <Drawing/Sheet/Sheet.h>

// Get the value of the property.
Ptr<CustomSheetSize> propertyValue = sheet_var->customSize();

// Set the value of the property, where value_var is a CustomSheetSize.
bool returnValue = sheet_var->customSize(value_var);

// Get the value of the property.
propertyValue = sheet_var.customSize;

// Set the value of the property.
sheet_var.customSize = propertyValue;

Property Value

Version