Click or drag to resize

IDisplayOverlaysAutoDisplayTemplateID Property

A TemplateID to use for automatic feature display

Namespace:  MediaCy.IQL.Features
Assembly:  MediaCy.IQL.Features (in MediaCy.IQL.Features.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Property AutoDisplayTemplateID ( 
	Optional bUpdateDisplay As Boolean = false
) As Integer
	Get
	Set

Parameters

bUpdateDisplay (Optional)
Type: SystemBoolean
[in, defaultvalue(FALSE)] If TRUE, then on assignment, all existing features will be (re)displayed using the new AutoDisplayTemplateID property. Before the new display is done, all existing linked graph objects are deleted from any overlay that has any template with the AutoDisplayTemplateID. The display is not disturbed for overlays without any template with the new AutoDisplayTemplateID. This argument has no effect when accessing the property.

Property Value

Type: Int32
Remarks
The McFeatures.AutoDisplay property is a shortcut to the standard assignment to this property, and assigments to that property is usually the only access to this one that is needed. If this property is set to some TemplateID value other than mcgtAnyTemplate (-1), then it will be used to automatically link features with McGraphObj instances with that TemplateID. AutoDisplayTemplateID is initially set to mcgtAnyTemplate, so that by default no automatic feature display occurs. Auto feature display is enabled for each McGraphOverlay in the collection that has an existing template with a TemplateID matching AutoDisplayTemplateID (if AutoDisplayTemplateID is mcgtDefaultTemplate, then auto display is enabled for all McGraphOverlay's in the collection) When any new feature is added to the Parent McFeatures, then for each McGraphOverlay with auto display enabled, a linked McGraphObj will be added to the McGraphOverlay using the AutoDisplayTemplateID with a class appropriate for the type of feature, as follows: For McPoints, the McGraphObj class will be "McGraphObjPoint". For McLines, the McGraphObj class will be either "McGraphObjLine" (for lines of type mcftLine) or "McGraphObjPoly" (for lines of type mcftPolyline). For McRegions, the McGraphObj class will be either "McGraphObjRect" (for regions of type mcftBox), "McGraphObjRRect" (for features of type mcftRoundedBox), "McGraphObjEllipse" (for regions of type mcftEllipse), or "McGraphObjPoly" (for all other region types). An assignment to this property will automatically display in each enabled McGraphOverly all existing features that are unlinked in that overlay. This is allows resynchronization with features auto displayed while the AutoDisplayTemplateID was set by some other project. However to keep confusion to a minimum, by convention McGraphOverlays that want to do auto display of features should define a Template with a TemplateID of mcgtStandardAutoDisplay. McGraphOverlay's Add'ed to the DisplayOverlays collection by name and the default overlay named "DefaultOverlay" have a Template with TemplateID mcgtStandardAutoDisplay automatically created.
See Also