Methods_T_CAEX_ClassModel_Validation_CAEXTables

CAEXTables Methods

The CAEXTables type exposes the following members.

Methods

 

	Name	Description
	AddCAEXObject	Update the Tables with an added CAEXObject. The CAEX-Object is registered with its Key which is the Object-ID for the IDTable and the CAEXPath(CAEXBasicObject) for the PathTable. If the asynchronous mode is selected, this Method is queued in the update execution queue. If the Task is completed, a TableUpdateEvent is raised with UpdateAction set to UpdateTaskCompleted.
	ElementsReferencedInInternalLinks	Gets all InternalElements and SystemUnitClasses that are referenced in all InternalLinks in the current Document. If an Element is referenced more than one time, it is returned only once. The Method will block, if any update tasks are pending.
	HasRegisteredInternalLinkReference	Determines whether the specified externalInterface has registered InternalLink references.
	HasRegisteredReference	Determines whether the specified caex-Object has registered references.
	InternalElementMirrors	Gets the InternalElement-Mirror Objects for a specified InternalElement. The Method will block, if any update tasks are pending.
	InternalLinkPartners	returns a collection of registered InternalLink-Partners for the specified external interface.
	InternalLinkReferences	returns a collection of registered InternalLinks for the specified external interface.
	InternalLinkReferencesOfElement	Get all InternalLinks that reference the specified InternalElement or SystemUnitClass. The Method will block, if any update tasks are pending.
	InternalLinkReferencesOfInterface	Get all InternalLinks that reference the specified ExternalInterface. The Method will block, if any update tasks are pending.
	IsMaster	Determines whether the specified InternalElement is master. The Method will block, if any update tasks are pending.
	MappingReferencesOfRoleReference	returns the mapping elements, which are related to the specified role reference. The Relation is bound to any AttributeNameMapping or InterfaceNameMapping, which refers to an attribute or interface of the referenced role.
	ReferencesWithAlias	returns all References which use the specified referenceAttribute and contain the specified alias in the referenced path value of this attribute
	RegisteredReferences	returns a collection of registered references for the specified caex-Object.
	RemoveCAEXObject	Removes the specified Caex-Object from all Tables. If the asynchronous mode is selected, this Method is queued in the update execution queue. If the Task is completed, an TableUpdateEvent is raised with UpdateAction. set to UpdateTaskCompleted.
	Reset	Resets all tables. The Table will be automatically updated if any of the Fast Access Methods FindFastByID(String, Boolean) or FindFastByPath(String, Boolean) are called or if the UpdateAllTables(Boolean) Method is called for an explicit Update. The Method may be helpful, to make a bulk of changes to the CAEXDocument without the need to update the tables after each change.
	UpdateAllReferenceAttributes	Updates all Path- and ID-References to the specified CaexElement. This Method changes the value of the Reference-Attribute in all CAEX-Objects which are registered in the PathRefTable and IDRefTable. For each updated reference a TableUpdateEvent is raised with UpdateAction set to IDReferenceChanged for changed ID-Reference and PathReferenceChanged for changed Path-References. If the asynchronous mode is selected, this Method is queued in the update execution queue. If the Task is completed, a TableUpdateEvent is raised with UpdateAction set to UpdateTaskCompleted.
	UpdateAllTables	Update all Tables which makes access to CAEXElements with keys faster. All Descendants of the CAEXFile-Node, which are managed, are registered with their actual Keys. If a Key changes for a Caex-Object, UpdateCAEXObjectRegistration(CAEXBasicObject, Boolean, Boolean) should be called. This Method is queued in the update execution queue if the async-Parameter is true. If the Task is completed, a TableUpdateEvent is raised with UpdateAction set to UpdateTaskCompleted. Remarks For an asynchronous execution, this Method will only be executed, if it is not already waiting in the Update Execution Queue or already processing. If it is already running or waiting, the Call is not queued and the method returns false. If a synchronous execution is specified, all pending updates are aborted and the Tables are updated immediately. Return Value Type: true, if this method call is queued in the update execution queue
	UpdateCAEXObjectRegistration	Checks if the specified Caex-Object is already managed by any Table and updates the registration of the Caex-Object in all associated Tables, if the Caex-Object has a different Key than the registered key. In a deep update, the Node of the Caex-Object and all its descendants are checked. If the asynchronous mode is selected, this Method is queued in the update execution queue. If the Task is completed, a TableUpdateEvent is raised with UpdateAction set to UpdateTaskCompleted.
	UpdateExternalReferenceAttributes	Updates the external reference attributes.
	UpdateIDReferenceAttributes	Updates all ID-References to the specified CaexElement. This Method changes the value of the Reference-Attribute in all CAEX-Objects which are registered in the IDRefTable. For each updated reference a TableUpdateEvent is raised with UpdateAction set to IDReferenceChanged. If the asynchronous mode is selected, this Method is queued in the update execution queue. If the Task is completed, a TableUpdateEvent is raised with UpdateAction set to UpdateTaskCompleted.
	UpdatePathReferenceAttributes	Updates all path references to the specified CaexElement. This Method changes the value of the Reference-Attribute in all CAEX-Objects which are registered in the PathRefTable. For each updated reference a TableUpdateEvent is raised with UpdateAction set to PathReferenceChanged. If the asynchronous mode is selected, this Method is queued in the update execution queue. If the Task is completed, a TableUpdateEvent is raised with UpdateAction set to UpdateTaskCompleted.

  Back to Top

See Also

Reference

CAEXTables Class
CAEX_ClassModel.Validation Namespace