Click or drag to resize

mcGraphOverlayCommandFlags Enumeration

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

Namespace:  MediaCy.IQL.Display.Overlays
Assembly:  MediaCy.IQL.Display.Overlays (in MediaCy.IQL.Display.Overlays.dll) Version: 10.0.6912.0
Syntax
VB
Public Enumeration mcGraphOverlayCommandFlags
Members
  Member nameValueDescription
mcgovlcfNoFlags0No flags (or can be used for clearing flags).
mcgovlcfAll-1All flags (can be used for masking all flags).
mcgovlcfNoDefaultNames1State Flag. When set, theIMcGraphOverlayEx.DisplayName, IMcGraphObjEx.Name and IMcGraphObjEx.Description proprties do not return a default string when accessed. Instead, if the property has not been assigned, it is exposed as an empty string. If clear (the default state), access to IMcBasicFeatures.Name, FeatureNames and FeatureDescriptions will return a default descriptive string if the property has not been assigned. Note that if you wish to assign an blank string to these properties, you should assign a single space, since assigning an empty string causes a reversion to the default string.
mcgovlcfGetBoundsOfVisibleObjects65537Action Flag. When assignedto CommandFlags with a mask of mcgovlcfNoFlags, CommandData is set to the bounds of all displayed objects in image coordinates. These bounds are large enough to encompass a burned in display of the objects at 100% zoom. CommandData is cleared after once it is next accessed.
mcgovlcfRestartToolServerInstance65538Action Flag. Whenassigned to CommandFlags with a mask of mcgovlcfNoFlags, the IMcGraphToolServer instance in CommandData is used to restart the current tool on this instance. CommandData is cleared after this action is completed.
mcgovlcfGetIMcBasicView65539Action Flag. Whenassigned to CommandFlags with a mask of mcgovlcfNoFlags, CommandData is set to the IMcBasicView on which the overlay is currently active; Nothing is returned if no IMcBasicView is active. Generally, this will be other than Nothing only during a notify event when a tool is running. Note that all IMcBasicView instances on which the overlay is being displayed will be available from the McGraphOverlay.Views collection; this action flag just returns the one, if any, which is currently active.
mcgovlcfGetIMcDibAccess65540Action Flag. Whenassigned to CommandFlags with a mask of mcgovlcfNoFlags, CommandData is first examined to see if it holds an IMcBasicView; if so, CommandData is set to the IMcDibAccess instance associated with that IMcBasicView. If CommandData is empty when called, then CommandData is set to the IMcDibAccess instance associated with the the IMcBasicView for the McView or McDisplay on which the overlay is currently active. Generally, the default IMcBasicView will be active only during a notify event. The IMcDibAccess.GetSourceInfo method may be called to get source information, including frame count and source dimensions.
mcgovlcfSetWorkingZoomForImageSize65541Action Flag. Whenassigned to CommandFlags with a mask of mcgovlcfNoFlags, CommandData is either a McImage, McView, McDisplay, IMcBasicView, IMcDibAccess or a length-2 value giving the X,Y pixel dimensions of the image being displayed. The same algorithm is applied to the McGraphOverlay.WorkingZoom that is automatically applied on McGraphOverlay initialization when the overlay is a descendent of a McImage.
mcgovlcfGetMcDisplay65542Action Flag. Whenassigned to CommandFlags with a mask of mcgovlcfNoFlags, CommandData is first examined to see if it holds an IMcBasicView; if so, CommandData is set to the McDisplay instance associated with that IMcBasicView. If CommandData is empty when called, then CommandData is set to the McDisplay instance associated with the the IMcBasicView on which the overlay is currently active; Nothing is returned if no IMcBasicView is active. Generally, the default IMcBasicView will be active only during a notify event.
mcgovlcfResetAutoLabelPositionAllObjects131073Action Flag. Whenassigned to CommandFlags with a mask of mcgovlcfNoFlags, any labels for which the McGraphObjTextEx.TextControlFlags masked by mcGraphObjTextControlFlags.mcgotcfLabelOffsetOptionsMask is anything other than mcGraphObjTextControlFlags.mcgotcfLabelOffsetAuto will be set to mcGraphObjTextControlFlags.mcgotcfLabelOffsetAuto, which will restore the label position to its default, automatic placement. McGraphOverlay.IsActionAvailable( mcGraphOverlayActions.mcgoaResetAutoLabelPositionAllObjects) will return True if there are any existing labels that would be affected by this action.
mcgovlcfResetAutoLabelPositionSelectedOnly131074Standard Data Storage Action Flags (assigned with mask of zero)
mcgovlcfDataGet-556883968When assigned, gets the dataelement identified by the lowest 12 bits of the command into CommandData. CommandData is cleared once it is next accessed.
mcgovlcfDataSet-556879872When 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.
mcgovlcfDataClear-556875776When assigned, clears the dataelement identified by the lowest 12 bits of the command.
mcgovlcfDataClearAll-556871680When assigned, clears all storeddata elements.
mcgovlcfDataList-556867584When assigned, sets CommandDatato an array of integers identifying the storage elements than have been assigned to and not yet cleared.
mcgovlcfDataElementMask4095A mask for the data element portionof the mcgovlcfDataXxxx action commands.
mcgovlcfSaveAsBytes-556859392When 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 mcgovlcfSaveAsBytesSucceeded will set CommandData to False.
mcgovlcfSaveAsBytesSucceeded-556859391When assigned, sets CommandDatato True if the last mcgovlcfSaveAsBytes succeeded in saving CommandData and all data elements. If the last mcgovlcfSaveAsBytes encountered a non-savable element, CommandData will be set False.
mcgovlcfLoadFromBytes-556859390When assigned, assumesCommandData is an array of bytes previously created by a mcgovlcfSaveAsBytes assignment. CommandFlags, CommandData and all data elements are restored from this array.
See Also