mcDisplayedObjectsFlags Enumeration |
|
Descripition: Allowed flags for the mcdoFlags argument when accessing theMcFeatures.DisplayedObjects property.
Namespace: MediaCy.IQL.Features
Assembly: MediaCy.IQL.Features (in MediaCy.IQL.Features.dll) Version: 10.0.6912.0
SyntaxVB
Public Enumeration mcDisplayedObjectsFlags
Members| Member name | Value | Description | |
|---|---|---|---|
| mcdoNoFlags | 0 | No flags. Linked McGraphObjinstances from will be added to the collection. If varMcGraphOverlay is empty or missing, then only objects in the DisplayOverlays.MasterGraphOverlay will be added. | |
| mcdoAllOverlays | 1 | If set and varMcGraphOverlay isempty or missing, expose linked McGraphObj instances in all McGraphOverlay's in the DisplayOverlays collection, not just the DisplayOverlays.MasterGraphOverlay. If clear and any DisplayOverlays.MasterGraphOverlay is set, then only McGraphObj instances that are part of the DisplayOverlays.MasterGraphOverlay are included in the DisplayedObjects collection. The idea behind this default behavior is that if you have set DisplayOverlays.MasterGraphOverlay, then you are most likely only interested in manipulating its graphic objects, not others in the DisplayOverlays collection. | |
| mcdoDoNotPopulate | 2 | If set, the DisplayedObjects is returnedempty. All other flags (except mcdoKeepReferences) and arguments are ignored. Use this flag if you want to populate the collection yourself via the Add method. | |
| mcdoGetTemplates | 4 | If set, the collection is filledwith template McGraphObj instances that match the varTemplateIDs argument rather than with McGraphObj instances linked to features. Unless the mcdoMasterTemplatesOnly or mcdoLabelTemplatesOnly flags are set, both "Master" and "Label" templates are added to the collection. | |
| mcdoOneGraphObjPerFeature | 8 | If set, the collection is filledwith one entry per selected feature. If a particular feature has no linked McGraphObj then Nothing is the value returned for that feature. If more than one McGraphObj is linked to the feature (as might happen if the mcdoAllOverlays flag bit is also set and in other rare situations), then only one McGraphObj is added to the collection for that feature. | |
| mcdoMasterTemplatesOnly | 16 | If or'ed with the mcdoGetTemplatesflag, then only "Master" templates are added to the collection, not "Label" templates. | |
| mcdoLabelTemplatesOnly | 32 | If or'ed with the mcdoGetTemplatesflag, then only "Label" templates are added to the collection, not "Master" templates. | |
| mcdoKeepReferences | 256 | If set then a reference is held on the creatingMcFeatures, on each of the McGraphObj instances in the collection and on the McGraphObj.Overlay of each of those instances. This flag is rarely needed because in virtually all uses of the lifetime of a McFeatures.DisplayedObjects collection is brief and is guaranteed to end before the collection's contents are fully released. Use of this flag will keep the creating McFeatures, all of its McGraphObj instances and their associated McGraphObj.Overlay(s) alive until the DisplayedObjects instance is fully released (which may not happen until Garbage Collection). Note that keeping a reference on a McGraphObj does not stop it from being removed from its McGraphObj.Overlay and being undisplayed. This flag will rarely, if ever, be needed. |
RemarksFlags can be OR'ed together to
control which linked McGraphObj instances are included in the collection.
See Also