mcGraphObjCommandFlags Enumeration

Predefined flags and command codes for the IMcGraphObjEx.CommandFlags property.

Namespace: MediaCy.IQL.Display.Overlays
Assembly: MediaCy.IQL.Display.Overlays (in MediaCy.IQL.Display.Overlays.dll) Version: 10.0.6912.0

Syntax

Copy

Public Enumeration mcGraphObjCommandFlags

Members

Member name	Value	Description
mcgobjcfNoFlags	0	No flags.
mcgobjcfGetMasterObject	67108865	Action flag. Whenassigned to CommandFlags with a mcgobjcfNoFlags mask, fills CommandData with the McGraphObj object which is the master object of this one, if this object is a LabelObject, or Nothing otherwise. The CommandData is cleared to Empty after it is accessed.
mcgobjcfGetInvalidateClientRect	67108866	Action flag returningview-dependent information. If the CommandData holds an IMcBasicView instance when the action flag is assigned, then that is the view for which information will be returned; otherwise the currently active IMcBasicView will be used (see mcGraphOverlayCommandFlags.mcgovlcfGetIMcBasicView). This value will only be valid during an event. If no IMcBasicView is supplied and none is active, then the CommandData will be set to Nothing. For label McGraphObjText, the return value will be Nothing unless the label will actually be displayed; this can be determined with the mcgobjcfGetWillObjectShow action flag. When mcgobjcfGetInvalidateClientRect is assigned to CommandFlags with a mcgobjcfNoFlags mask, CommandData is with a LONGRECT value giving the client coordinates of the object's rotated bounding rectangle including extra space for selection handles. The returned rectangle is an overestimate of the client bounds of the displayed object.
mcgobjcfGetUnrotatedClientRect	67108867	Action flag returningview-dependent information. If the CommandData holds an IMcBasicView instance when the action flag is assigned, then that is the view for which information will be returned; otherwise the currently active IMcBasicView will be used (see mcGraphOverlayCommandFlags.mcgovlcfGetIMcBasicView). This value will only be valid during an event. If no IMcBasicView is supplied and none is active, then the CommandData will be set to Nothing. For label McGraphObjText, the return value will be Nothing unless the label will actually be displayed; this can be determined with the mcgobjcfGetWillObjectShow action flag. When mcgobjcfGetUnrotatedClientRect is assigned to CommandFlags with a mcgobjcfNoFlags mask, CommandData is with a LONGRECT value giving the client coordinates of the object's un-rotated and un-normalized bounding rectangle. The center point of this rectangle will be the Client coordinate center-of-rotation for the object (Handle 0). For McGraphObjRect-based objects, the Left-Top point will be Handle 1, while the Right-Bottom point will be Handle 5. For McGraphObjLine objects the Left-Top point will be Handle 1, while the Right-Bottom point will be Handle 2.
mcgobjcfSetHandlesOfInterest	67108869	Action flag. Whenassigned to CommandFlags with a mcgobjcfNoFlags mask, CommandData must set to an Integer selector for handle numbers from 0 (the center of rotation) up through the number of handles for the graphic object. A selector can be -1, which specifies all handles, a single scalar handle or an array of handle numbers. This sets the handle or handles for which information will be returned by the mcgobjcfGetHandleClientCoord and mcgobjcfGetHandleApparentImageCoord action flags. McGraphObjPoint has 1 handle, McGraphObjLine has 2 handles, all McGraphObjRect-derived types have 8 handles and McGraphObjPoly has McGraphObjPoly.PointCount handles. The default handle-of-interest is 0.
mcgobjcfGetHandleClientCoord	67108870	Action flag returningview-dependent information. If the CommandData holds an IMcBasicView instance when the action flag is assigned, then that is the view for which information will be returned; otherwise the currently active IMcBasicView will be used (see mcGraphOverlayCommandFlags.mcgovlcfGetIMcBasicView). This value will only be valid during an event. If no IMcBasicView is supplied and none is active, then the CommandData will be set to Nothing. For label McGraphObjText, the return value will be Nothing unless the label will actually be displayed; this can be determined with the mcgobjcfGetWillObjectShow action flag. When mcgobjcfGetHandleClientCoord is assigned to CommandFlags with a mcgobjcfNoFlags mask, CommandData is set to a scalar or array of SINGLEPOINT giving the Client coordinates of the current set of handles-of-interest (see mcgobjcfSetHandlesOfInterest). See also mcgobjcfGetHandleApparentImageCoord.
mcgobjcfGetHandleApparentImageCoord	67108871	Action flag returningview-dependent information. If the CommandData holds an IMcBasicView instance when the action flag is assigned, then that is the view for which information will be returned; otherwise the currently active IMcBasicView will be used (see mcGraphOverlayCommandFlags.mcgovlcfGetIMcBasicView). This value will only be valid during an event. If no IMcBasicView is supplied and none is active, then the CommandData will be set to Nothing. For label McGraphObjText, the return value will be Nothing unless the label will actually be displayed; this can be determined with the mcgobjcfGetWillObjectShow action flag. When mcgobjcfGetHandleApparentImageCoord is assigned to CommandFlags with a mcgobjcfNoFlags mask, CommandData is set to a scalar or array of SINGLEPOINT giving the apparent image coordinates of the current set of handles-of-interest (see mcgobjcfSetHandlesOfInterest). The apparent image coordinates are the location of the point on the image upon which the handle will be displayed. For non-label objects with the McGraphObj.ZoomWithImage=True, this location is the same as that returned by the McGraphObj.GetPoint method. But for McGraphObjText objects which are labels and for See also mcgobjcfGetHandleClientCoord.
mcgobjcfGetWillObjectShow	67108874	Action flag returningview-dependent information. If the CommandData holds an IMcBasicView instance when the action flag is assigned, then that is the view for which information will be returned; otherwise the currently active IMcBasicView will be used (see mcGraphOverlayCommandFlags.mcgovlcfGetIMcBasicView). This value will only be valid during an event. If no IMcBasicView is supplied and none is active, then the CommandData will be set to Nothing. When mcgobjcfGetWillObjectShow is assigned to CommandFlags with a mcgobjcfNoFlags mask, CommandData is filled with a Boolean True/False value which is True only if this McGraphObj's bounds fall within the IMcBasicView client rectangle. A label will be shown only if its parent falls within the client rectangle. The display frame is not tested, so some McGraphObj instances may not display on some frames even when the return value is True.
mcgobjcfGetPointerLineClientCoords	67108875	Action flag returningview-dependent information. If the CommandData holds an IMcBasicView instance when the action flag is assigned, then that is the view for which information will be returned; otherwise the currently active IMcBasicView will be used (see mcGraphOverlayCommandFlags.mcgovlcfGetIMcBasicView). This value will only be valid during an event. If no IMcBasicView is supplied and none is active, then the CommandData will be set to Nothing. For label McGraphObjText, the return value will be Nothing unless the label will actually be displayed; this can be determined with the mcgobjcfGetWillObjectShow action flag. When mcgobjcfGetPointerLineClientCoords is assigned to CommandFlags with a mcgobjcfNoFlags mask, CommandData is filled with a length-2 array of LONGPOINT value giving, respectively, the anchor (ending) and text (starting) client coordinates of any pointer line associated with a McGraphObjText object. If this McGraphObjText is a label, then the first element in the array will be the anchor point on the master object while the second element will be the point on the label boundary that is where the label anchor pointer symbol is placed (unless the McGraphObjTextEx.TextControlFlags mcGraphObjTextControlFlags.mcgotcfHideLabelAnchorMarker bit is set). For non-label McGraphObjText, the two points give the client coordinates of any displayed pointer line.
mcgobjcfGetLabelAnchorCornerHandle	67108876	Action flag returningview-dependent information. If the CommandData holds an IMcBasicView instance when the action flag is assigned, then that is the view for which information will be returned; otherwise the currently active IMcBasicView will be used (see mcGraphOverlayCommandFlags.mcgovlcfGetIMcBasicView). This value will only be valid during an event. If no IMcBasicView is supplied and none is active, then the CommandData will be set to Nothing. For label McGraphObjText, the return value will be Nothing unless the label will actually be displayed; this can be determined with the mcgobjcfGetWillObjectShow action flag. When mcgobjcfGetLabelAnchorCornerHandle assigned to CommandFlags with a mcgobjcfNoFlags mask, fills CommandData with an Integer giving the Handle number (1 through 8) of the corner or side that is connected to the master's label anchor point.
mcgobjcfGetUserCreateImageSize	67108880	Action flag. Whenassigned to CommandFlags with a mcgobjcfNoFlags mask, fills CommandData with a length-2 Integer (e.g. VT_I4) giving the X,Y size of the image being displayed on the current IMcBasicView at the time that the object was created by the user. For all programatically created objects, including those created via a link to a McFeatures, the value is 0.
mcgobjcfGetUserCreateMagnification	67108881	Action flag. Whenassigned to CommandFlags with a mcgobjcfNoFlags mask, fills CommandData with a double value giving the magnification on the current IMcBasicView running the creation tool at the time that the object was created by the user. For all programatically created objects, including those created via a link to a McFeatures, the value is 0.
mcgobjcfGetUserCreateWorkingZoom	67108882	Action flag. Whenassigned to CommandFlags with a mcgobjcfNoFlags mask, fills CommandData with a double value giving the McGraphOverlay.WorkingZoom at the time that the object was created by the user. For all programatically created objects, including those created via a link to a McFeatures, the value is 0.
mcgobjcfMarkAsUserCreated	67108885	Action flag requiringview-dependent information. If the CommandData holds an IMcBasicView instance when the action flag is assigned, then that is the view for which information will be returned; otherwise the currently active IMcBasicView will be used (see mcGraphOverlayCommandFlags.mcgovlcfGetIMcBasicView). This value will only be valid during an event. If no IMcBasicView is supplied and none is active, then the CommandData will be set to Nothing. For label McGraphObjText, the return value will be Nothing unless the label will actually be displayed; this can be determined with the mcgobjcfGetWillObjectShow action flag. When mcgobjcfMarkAsUserCreated assigned to CommandFlags with a mcgobjcfNoFlags mask, the McGraphObjEx.ExtendedStyle is marked mcGraphObjExtendedStyle.mcgesUserCreated, and if the IMcGraphOverlayEx.OptionFlags mcGraphOverlayOptionFlags.mcgoofSetZoomLimitOnUserCreate bit is set, then the ZoomWithImageLimit will be set if the current zoom on the supplied IMcBasicView is sufficiently greater than the McGraphOverlay.WorkingZoom.
mcgobjcfCopyUserCreateState	67108886	Standard Data Storage Action Flags (assigned with mask of zero)
mcgobjcfDataSlot_UserCreateInfo	10	Base of a mcgobjcfDataSet/Get slotwhere 4 double values are stored holding the mcgobjcfGetUserCreateImageSize, mcgobjcfGetUserCreateMagnification and mcgobjcfGetUserCreateWorkingZoom values, if those values are defined.
mcgobjcfDataGet	-556883968	When assigned, gets the dataelement identified by the lowest 12 bits of the command into CommandData. CommandData is cleared once it is next accessed.
mcgobjcfDataSet	-556879872	When assigned, sets the dataelement identified by the lowest 12 bits of the command from the current CommandData. CommandData is cleared after its value is stored.
mcgobjcfDataClear	-556875776	When assigned, clears the dataelement identified by the lowest 12 bits of the command.
mcgobjcfDataClearAll	-556871680	When assigned, clears all storeddata elements.
mcgobjcfDataList	-556867584	When assigned, sets CommandDatato an array of integers identifying the storage elements than have been assigned to and not yet cleared.
mcgobjcfDataElementMask	4095	A mask for the data element portionof the mcgobjcfDataXxxx action commands.
mcgobjcfSaveAsBytes	-556859392	When assigned, sets CommandDatato an array of bytes holding a full representation of CommandFlags, CommandData and all data elements. CommandData and data elements holding Object references or Structures (Records) cannot be saved as bytes. Such elements will not be saved, and a subsequent assignment of the mcgobjcfSaveAsBytesSucceeded will set CommandData to False.
mcgobjcfSaveAsBytesSucceeded	-556859391	When assigned, sets CommandDatato True if the last mcgobjcfSaveAsBytes succeeded in saving CommandData and all data elements. If the last mcgobjcfSaveAsBytes encountered a non-savable element, CommandData will be set False.
mcgobjcfLoadFromBytes	-556859390	When assigned, assumesCommandData is an array of bytes previously created by a mcgobjcfSaveAsBytes assignment. CommandFlags, CommandData and all data elements are restored from this array.

Reference

MediaCy.IQL.Display.Overlays Namespace