Description
An McDisplayedObjects collection of McGraphObj instances.
-
Property type
-
A McDisplayedObjects object.
-
Syntax
-
object.DisplayedObjects([varFeatureSelector], [varMcGraphOverlay], [varTemplateIDs], [mcdoFlags])
The DisplayedObjects Property syntax has these parts: |
| object | An expression evaluating to an object of type McLines. | | varFeatureSelector | Optional. A Variant value. An empty variant, a single negative value, a single index value, or an array of zero or more index values (negative index values are legal but will be ignored).
If the varFeatureSelector argument is a non-negative scalar value, then the only McGraphObj links to that indexed feature are included in the DisplayedObjects collection.
If the varFeatureSelector argument is missing or any negative value, then McGraphObj links to all features are included in the DisplayedObjects collection.
If varFeatureSelector is an array, then zero or positive values are treated as indices into the features collection, negative values are legal but ignored. In this case, McGraphObj links to any of the indexed features are included in the DisplayedObjects collection.
| | varMcGraphOverlay | Optional. A Variant value. An empty variant or an instance of a McGraphOverlay. If given, this is the McGraphOverlay that McGraphObj instances added to the collection are to have as their Overlay property. If empty or missing, then either the DisplayOverlays.MasterGraphOverlay is assumed, or if DisplayOverlays.MasterGraphOverlay is Nothing or the mcdoAllOverlays mcDisplayedObjectsFlags bit is set, then McGraphObj instances from all overlays in the DisplayOverlays collection are included.
| | varTemplateIDs | Optional. A Variant value. An empty variant, a single value of -1, some other single value, or an array of zero or more values.
If varTemplateIDs is empty or missing or the scalar value of -1 (i.e., mcgtAnyTemplate), then McGraphObj instances created with any TemplateID value are included in the DisplayedObjects collection.
If varTemplateIDs is some scalar value other than mcgtAnyTemplate (i.e., -1) or is an array of values, then McGraphObj instances created with any of the listed TemplateID value are included in the DisplayedObjects collection.
| | mcdoFlags | Optional. A mcDisplayedObjectsFlags enumeration, as described in settings. Flags that can be OR'ed together to control which linked McGraphObj instances are included in the collection. If the mcdoGetTemplates flag is set, then template McGraphObj instances rather than McGraphObj instances linked to features are added to the collection; in this case, the varFeatureSelector argument is ignored, but any varMcGraphOverlay and/or varTemplateIDs arguments are honored.
|
Settings The settings for mcdoFlags are:
|
 | mcdoNoFlags | 0 |
No flags. Linked McGraphObj instances 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 is empty 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 returned empty. All other flags 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 filled with 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.
|
| mcdoMasterTemplatesOnly | 16 |
If or'ed with the mcdoGetTemplates flag, then only “Master” templates are added to the collection, not “Label” templates.
|
| mcdoLabelTemplatesOnly | 32 |
If or'ed with the mcdoGetTemplates flag, then only “Label” templates are added to the collection, not “Master” templates.
|
Remarks
The DisplayedObjects property exposes a “snapshot” collection of McGraphObj instances that are linked for display to selected features. It may also be used to get some or all of the templates that these McGraphObj instances my be based on.
The McDisplayedObjects interface methods allow you to set McGraphObj properties (e.g., BorderColor) or label text for the whole collection with a single call.
On access, a new instance of an McDisplayedObjects collection is created and then populated with the current set of McGraphObj instances linked to the features, as filtered by the arguments. Included graph objects must meet all of the filter requirements.
Only “Master” McGraphObj instances are included in the collection, any associated “Label” McGraphObjText instances are not included. However, several methods will automatically set properties in these label graph objects, if they exist.
Exceptions
varFeatureSelector index values greater or equal to the Count property are illegal.
|
DisplayedObjects Property (McLines)
