ClassesClassesClassesClasses | | | | Operators

get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParams (Operator)

Name

get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParams — Get the parameters of a drawing object.

Signature

get_drawing_object_params( : : DrawID, ParamNames : ParamValues)

Herror get_drawing_object_params(const Hlong DrawID, const char* ParamNames, double* ParamValues)

Herror T_get_drawing_object_params(const Htuple DrawID, const Htuple ParamNames, Htuple* ParamValues)

Herror get_drawing_object_params(const HTuple& DrawID, const HTuple& ParamNames, double* ParamValues)

Herror get_drawing_object_params(const HTuple& DrawID, const HTuple& ParamNames, HTuple* ParamValues)

HTuple HDrawingObject::GetDrawingObjectParams(const HTuple& ParamNames) const

void GetDrawingObjectParams(const HTuple& DrawID, const HTuple& ParamNames, HTuple* ParamValues)

HTuple HDrawingObject::GetDrawingObjectParams(const HTuple& ParamNames) const

HTuple HDrawingObject::GetDrawingObjectParams(const HString& ParamNames) const

HTuple HDrawingObject::GetDrawingObjectParams(const char* ParamNames) const

void HOperatorSetX.GetDrawingObjectParams(
[in] VARIANT DrawID, [in] VARIANT ParamNames, [out] VARIANT* ParamValues)

VARIANT HDrawingObjectX.GetDrawingObjectParams([in] VARIANT ParamNames)

static void HOperatorSet.GetDrawingObjectParams(HTuple drawID, HTuple paramNames, out HTuple paramValues)

HTuple HDrawingObject.GetDrawingObjectParams(HTuple paramNames)

HTuple HDrawingObject.GetDrawingObjectParams(string paramNames)

Description

get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParams can be used to query the parameters that describe the drawing object DrawIDDrawIDDrawIDDrawIDDrawIDdrawID. One may specifiy one or several parameters which will be retrieved in the output tuple ParamValuesParamValuesParamValuesParamValuesParamValuesparamValues, in the same order as specified in the input tuple ParamNamesParamNamesParamNamesParamNamesParamNamesparamNames.

In addition to the parameters described in set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParams following parameters are possible for ParamNamesParamNamesParamNamesParamNamesParamNamesparamNames:

'type':

Returns the type of the drawing object. Possible return values are: 'circle'"circle""circle""circle""circle""circle", 'circle_sector'"circle_sector""circle_sector""circle_sector""circle_sector""circle_sector", 'ellipse'"ellipse""ellipse""ellipse""ellipse""ellipse", 'ellipse_sector'"ellipse_sector""ellipse_sector""ellipse_sector""ellipse_sector""ellipse_sector", 'rectangle1'"rectangle1""rectangle1""rectangle1""rectangle1""rectangle1", 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2""rectangle2", 'line'"line""line""line""line""line", 'xld'"xld""xld""xld""xld""xld", 'text'"text""text""text""text""text"

Parallelization

Parameters

DrawIDDrawIDDrawIDDrawIDDrawIDdrawID (input_control)  drawing_object HDrawingObject, HTupleHTupleHDrawingObject, HTupleHDrawingObjectX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the drawing object.

ParamNamesParamNamesParamNamesParamNamesParamNamesparamNames (input_control)  attribute.name(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Parameter names of the drawing object.

List of values: 'color'"color""color""color""color""color", 'column'"column""column""column""column""column", 'column1'"column1""column1""column1""column1""column1", 'column2'"column2""column2""column2""column2""column2", 'end_angle'"end_angle""end_angle""end_angle""end_angle""end_angle", 'font'"font""font""font""font""font", 'length1'"length1""length1""length1""length1""length1", 'length2'"length2""length2""length2""length2""length2", 'line_style'"line_style""line_style""line_style""line_style""line_style", 'line_width'"line_width""line_width""line_width""line_width""line_width", 'phi'"phi""phi""phi""phi""phi", 'radius'"radius""radius""radius""radius""radius", 'radius1'"radius1""radius1""radius1""radius1""radius1", 'radius2'"radius2""radius2""radius2""radius2""radius2", 'row'"row""row""row""row""row", 'row1'"row1""row1""row1""row1""row1", 'row2'"row2""row2""row2""row2""row2", 'start_angle'"start_angle""start_angle""start_angle""start_angle""start_angle", 'string'"string""string""string""string""string", 'type'"type""type""type""type""type"

ParamValuesParamValuesParamValuesParamValuesParamValuesparamValues (output_control)  attribute.name(-array) HTupleHTupleHTupleVARIANTHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*) (double / Hlong / BSTR) (double / Hlong / char*)

Parameter values.

Result

get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParams returns 2 (H_MSG_TRUE), if the DrawIDDrawIDDrawIDDrawIDDrawIDdrawID is valid. Otherwise an exception is raised.

Possible Predecessors

create_drawing_object_rectangle1create_drawing_object_rectangle1CreateDrawingObjectRectangle1create_drawing_object_rectangle1CreateDrawingObjectRectangle1CreateDrawingObjectRectangle1, create_drawing_object_rectangle2create_drawing_object_rectangle2CreateDrawingObjectRectangle2create_drawing_object_rectangle2CreateDrawingObjectRectangle2CreateDrawingObjectRectangle2, create_drawing_object_ellipsecreate_drawing_object_ellipseCreateDrawingObjectEllipsecreate_drawing_object_ellipseCreateDrawingObjectEllipseCreateDrawingObjectEllipse, create_drawing_object_circlecreate_drawing_object_circleCreateDrawingObjectCirclecreate_drawing_object_circleCreateDrawingObjectCircleCreateDrawingObjectCircle, create_drawing_object_linecreate_drawing_object_lineCreateDrawingObjectLinecreate_drawing_object_lineCreateDrawingObjectLineCreateDrawingObjectLine, create_drawing_object_ellipse_sectorcreate_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSectorcreate_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSectorCreateDrawingObjectEllipseSector, create_drawing_object_circle_sectorcreate_drawing_object_circle_sectorCreateDrawingObjectCircleSectorcreate_drawing_object_circle_sectorCreateDrawingObjectCircleSectorCreateDrawingObjectCircleSector, create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXld, create_drawing_object_textcreate_drawing_object_textCreateDrawingObjectTextcreate_drawing_object_textCreateDrawingObjectTextCreateDrawingObjectText, attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindow

Possible Successors

set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParams, attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindow, get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconic

Alternatives

get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconic

See also

attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindow, get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconic, set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParams

Module

Foundation


ClassesClassesClassesClasses | | | | Operators