Graphics Builder Automation Interface - Object Drawing and Property Functions

Extensibility > Graphics Builder Automation Interface > Graphics Builder Automation Interface - Object Drawing and Property Functions | Extensibility

Object Drawing and Property Functions

With these functions, you can draw objects and manipulate the properties of objects.

Note: Freehand line drawing is not supported, as the same output can be achieved using the DrawPolygon function.

Only General and 3D properties are supported. Movement, Scaling, Fill, and so on are not accessible.

The settings are applied to or read from the selected object. Typically, the last placed object is the selected object. By using the PageSelectFirstObject() and PageSelectNextObject() functions, you can access your objects and change or read their properties.

Attribute3dEffects	Applies a 3D effect to an object, or retrieves the current 3D effect setting.
Attribute3dEffectDepth	Applies a level of depth to a 3D effect, or retrieves the current depth setting.
AttributeAN	Retrieves the animation number (AN) of the active object.
AttributeBaseCoordinates	Returns the base coordinates of an object.
AttributeClass	Retrieves the class of the active object as a string.
AttributeCornerRadius	Sets or retrieves the corner radius value for the current object.
AttributeEllipseStyle	Applies a style to an ellipse, or retrieves the current ellipse style setting.
AttributeEndAngle	Sets the end angle of an arc or pie-slice, or retrieves the end angle.
AttributeExtentX	Retrieves the X coordinate that represents the extent of the active object.
AttributeExtentY	Retrieves the Y coordinate that represents the extent of the active object.
AttributeFillColour	Sets the fill color for an object, or retrieves a value representing the current fill color.
AttributeFillOffColourEx	Sets the fill color for an object, or retrieves a value representing the current fill color.
AttributeFillOnColourEx	Sets the fill color for an object, or retrieves a value representing the current fill color.
AttributeGradientMode	Sets or retrieves the direction of the gradient for the current object.
AttributeGradientOffColour	Sets or retrieves the "Off" portion of the gradient colour for the current object.
AttributeGradientOnColour	Sets or retrieves the "On" portion of the gradient colour for the current object.
AttributeHiLightColour	Sets the highlight color applied to the 3D effects raised, lowered or embossed, or retrieves the current highlight color setting.
AttributeLineColour	Applies a color to a line, or retrieves the current color setting. This function has been replaced by the functions AttributeLineOnColourEx and AttributeLineOffColourEx.
AttributeLineOnColourEx	This function supports True Color functionality and replaces AttributeLineColour.
AttributeLineOffColourEx	This function supports True Color functionality and replaces AttributeLineColour.
AttributeLineStyle	Applies a style to a line, or retrieves the current style setting.
AttributeLineWidth	Sets the width of a line, or retrieves its current width.
AttributeLoLightColour	Sets the lowlight color applied to the 3D effects raised, lowered or embossed, or retrieves the current lowlight color setting. As this function does not support True Colour functionality, it has been superseded by the functions AttributeLoLightOffColourEx and AttributeLoLightOnColourEx.
AttributeLoLightOffColourEx	Sets the lowlight "off" color applied to the 3D effects raised, lowered or embossed, or retrieves the current lowlight color setting.
AttributeLoLightOnColourEx	Sets the lowlight "on" color applied to the 3D effects raised, lowered or embossed, or retrieves the current lowlight color setting.
AttributeNodeCoordinatesFirst	Returns the coordinates of the first node of a free hand line, polygon or pipe.
AttributeNodeCoordinatesNext	Returns the coordinates of any following nodesA structural anchor point for a graphic object, usually visible as a small square box superimposed over a graphic. Nodes will be located separately at the start, at the end, and at every change in direction within a graphic object. of a free hand line, polygon or pipe when implemented after AttributeNodeCoordinatesFirst.
AttributePolygonOpen	Defines whether a polygon (polyline) is set to open mode (i.e. its two end points are not joined) or closed (its two ends are joined).
AttributeRectangleStyle	Sets the rectangle style, or retrieves the rectangle style setting.
AttributeSetFill	Displays the object as filled, or retrieves the current fill value.
AttributeShadowColour	Sets the shadow color when a shadowed 3D effect is used, or retrieves the current shadow color setting. As this function does not support True Color functionality, it has been superseded by the functions AttributeShadowOffColourEx and AttributeShadownOnColourEx.
AttributeShadowOffColourEx	Sets the "off" shadow color when a shadowed 3D effect is used, or retrieves the current shadow color setting.
AttributeShadowOnColourEx	Sets the "on" shadow color when a shadowed 3D effect is used, or retrieves the current shadow color setting.
AttributeStartAngle	Sets the start angle of an arc or pie-slice, or retrieves the start angle.
AttributeTransformationMatrixGet	Reads the elements of the transformation matrix.
AttributeTransformationMatrixPut	Sets the elements of the transformation matrix.
AttributeX	Retrieves the X coordinate of the active object.
AttributeY	Retrieves the Y coordinate of the active object.
DrawButton	Draws a button on the active page.
DrawCicodeObject	Places a Cicode object on the page at the specified location.
DrawEllipse	Draws an ellipse on the active page.
DrawLine	Draws a line on the active page.
DrawNumber	Places a number object on the page at the specified location.
DrawPipeEnd	Terminates the drawing of a pipe on the active page.
DrawPipeSection	Draws a section of pipe on the active page.
DrawPipeStart	Initiates the process of drawing a pipe on the active page by defining a starting point that DrawPipeSection() can be applied to.
DrawPolygonEnd	Terminates the drawing of a polygon on the active page.
DrawPolygonLine	Draws a line on the active page that forms part of a polygon.
DrawPolygonStart	Initiates the process of drawing a polygon on the active page by defining a starting point that DrawPolygonLine() can be applied to.
DrawRectangle	Draws a rectangle on the active page.
DrawSymbolSet	Places a Symbol Set object on the page at the specified location.
DrawText	Draws an alphanumeric string at the specified location.
DrawTrend	Draws a trend object on the active page.

For details and a VB example on handling return and error values, see Error Handling.