mcBasicFeaturesCommandFlags Enumeration |
|
Legal common values for the McBasicFeatures.CommandFlags property.
Namespace: MediaCy.IQL.Features
Assembly: MediaCy.IQL.Features (in MediaCy.IQL.Features.dll) Version: 10.0.6912.0
SyntaxVB
Public Enumeration mcBasicFeaturesCommandFlags
Members| Member name | Value | Description | |
|---|---|---|---|
| mcbfcfNone | 0 | No flags (or can be used for clearing flags). | |
| mcbfcfAll | -1 | All flags (can be used for masking all flags). | |
| mcbfcfNoDefaultNames | 1 | State Flag. When set,the IMcBasicFeatures.Name, CoordinateDimensionNames, FeatureNames and FeatureDescriptions 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, CoordinateDimensionNames, 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. | |
| mcbfcfHasDisplayOverlays | 268435457 | Action Flag. When assigned,CommandData is set to bool true if and only if the McFeatures has an existing DisplayOverlays collection with a non-zero Count. Unlike direct access to the McFeatures.DisplayOverlay collection, use of this action flag avoids creating the DisplayOverlays collection if it does not already exist. | |
| mcbfcfAutoSetSizeRatioPcnt | 268435458 | Action Flag. When assigned,CommandData should be empty, zero or a value up to 100. If a nonzero value, it is the percentage of theIMcImages.MemoryUsageLimit that a fully locked region access should be allowed to consume; if CommandData is zero or empty, the IMcImages.MemoryAutoLockLimit is used for this value. The IMcBasicView.SizeRatio property is automatically set to the smallest natural size ratio (closest to full resolution) such that a fully locked region access will not consume more than the specified amount of memory. After the assignment, CommandData will be True if the SizeRatio could be set successfully; False otherwise. | |
| mcbfcfAutoSetSizeRatioMBytes | 268435459 | Action Flag. When assigned,CommandData should be empty, zero or a positive value. If a nonzero value, it is a number of MBytes that a fully locked region access should be allowed to consume; if CommandData is zero or empty, the IMcImages.MemoryAutoLockLimit is used to compute this value. The IMcBasicView.SizeRatio property is automatically set to the smallest natural size ratio (closest to full resolution) such that a fully locked region access will not consume more than the specified amount of memory. After the assignment, CommandData will be True if the SizeRatio could be set successfully; False otherwise. | |
| mcbfcfHowManyFeaturesOverlap | 268435460 | Action Flag. When assigned,CommandData is set to a long (VT_I4) value, which will be non-zero if and only if the McFeatures two or more features whose scan lists overlap each other. This will only be non-zero for McLines or McRegions where the mcofKeepRegionsAsUnion OptionFlags bit is off. | |
| mcbfcfWhichFeaturesOverlap | 268435461 | Action Flag. When assigned,CommandData is set to an array of long (VT_I4) values holding the indices of any features whose scan lists overlap each other. This array will be other than zero length only for McLines or McRegions where the mcofKeepRegionsAsUnion OptionFlags bit is off. | |
| mcbfcfSetUserCreateMcBasicView | 536870917 | Action Flag. When assigned,CommandData needs to be set to a IMcBasicView instance or Nothing; If set to an IMcBasicView instance, then for linked McGraphObj instances created by this McFeatures, 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. No reference is held on the assigned IMcBasicView, but for safety, the value should be assigned to Nothing as soon as possible. | |
| mcbfcfDataGet | -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. | |
| mcbfcfDataSet | -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. | |
| mcbfcfDataClear | -556875776 | When assigned, clears the dataelement identified by the lowest 12 bits of the command. | |
| mcbfcfDataClearAll | -556871680 | When assigned, clears all storeddata elements. | |
| mcbfcfDataList | -556867584 | When assigned, sets CommandDatato an array of integers identifying the storage elements than have been assigned to and not yet cleared. | |
| mcbfcfDataElementMask | 4095 | A mask for the data element portionof the mcbfcfDataXxxx action commands. | |
| mcbfcfSaveAsBytes | -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 mcbfcfSaveAsBytesSucceeded will set CommandData to False. | |
| mcbfcfSaveAsBytesSucceeded | -556859391 | When assigned, sets CommandDatato True if the last mcbfcfSaveAsBytes succeeded in saving CommandData and all data elements. If the last mcbfcfSaveAsBytes encountered a non-savable element, CommandData will be set False. | |
| mcbfcfLoadFromBytes | -556859390 | When assigned, assumesCommandData is an array of bytes previously created by a mcbfcfSaveAsBytes assignment. CommandFlags, CommandData and all data elements are restored from this array. |
RemarksThese flags are useful for all McBasicFeatures. Each type of
McBasicFeatures will usually also have its own CommandFlags action and option
flags.
See Also