Scripting API

<<Resize Main Index ResourcesAndComponents>>
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

ResizeCanvas

Script Name: ResizeCanvas
Name: ResizeCanvas
Library: CmdBase2
Description: Change the size of the drawing canvas.
Status bar text: Change the size of the drawing canvas
Tool tip text: Resize Canvas
Undo text: Resize Canvas
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
AspectRatioAspectRatioRealThe aspect ratio of the canvas.No0.00.032767.0
Fill ColorFillColorColorColor used to fill any new space added.NoRed 255
Blue 255
Green 255
Red 0
Blue 0
Green 0
Red 255
Blue 255
Green 255
HoriPlaceHoriPlaceEnumeration (HorizontalType)Horizontal placement of the image on the canvas.NoCenter
MaintainAspectMaintainAspectEnumeration (Boolean)Check as to whether or not to maintain the aspect ratio while resizing the canvas.NoFalse
NewDimUnitsNewDimUnitsEnumeration (UnitsOfMeasure)New dimension unitsNoPixels
NewHeightNewHeightRealThe new height of the canvas.No0.00.020000.0
NewWidthNewWidthRealThe new width of the canvas.No0.00.020000.0
PlaceBottomPlaceBottomRealThe placement on the canvas for the bottom edge of the image.No-20000.0-20000.020000.0
PlaceLeftPlaceLeftRealThe placement on the canvas for the left edge of the image.No-20000.0-20000.020000.0
PlaceRightPlaceRightRealThe placement on the canvas for the right edge of the image.No-20000.0-20000.020000.0
PlaceTopPlaceTopRealThe placement on the canvas for the top edge of the image.No-20000.0-20000.020000.0
VertPlaceVertPlaceEnumeration (VerticalType)Vertical placement of the image on the canvas.NoCenter
General SettingsGeneralSettingsParameter RepositoryContains parameters that control the execution of the command.No
 
Command Attributes:
IsExternal: true
IsUndoable: true
ProcessChanges: true
FinalizeTransient: true
This command is safe for execution in a processing thread.: true
 
Resource Attributes:
HasWinPlacement: true
HelpID:32978
IsEditable: true