Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFModel Methods

  • Last UpdatedNov 18, 2025
  • 8 minute read
AFModel Methods

The AFModel type exposes the following members.

Methods

  NameDescription
Public methodCode example
ApplyChanges
This method applies the changes to the object and makes those changes available to other objects for the current user.
(Inherited from AFElement.)
Public method
ApplyQueryDate
Applies the specified query date to the current object and returns an object in the new context.
(Inherited from AFElement.)
Public method
ChangeReferenceType
Change the existing AFReferenceType between a child element or the AFDatabase.
(Inherited from AFElement.)
Public methodCode example
CheckIn
This method checks in (commits) all the changes to the object by saving the information to persistent storage.
(Inherited from AFElement.)
Public method
CheckOut
This method locks the object so that its configuration can be modified.
(Inherited from AFElement.)
Public method
CompareTo(Object)
Compares this instance with a specified Object.
(Inherited from AFObject.)
Public method
CompareTo(AFObject)
Compares this instance with a specified AFObject.
(Inherited from AFObject.)
Public methodCode example
ConvertTo
Converts the current object to the specified type of an AFElement.
(Inherited from AFElement.)
Public method
CreateDefaultPorts
This method can be used to create the default connection ports based upon the element's type.
(Inherited from AFElement.)
Public method
CreateElementTemplate
Create an AFElementTemplate based upon the element.
(Inherited from AFBaseElement.)
Public method
Delete
Deletes all versions of this element from the AFDatabase.
(Inherited from AFElement.)
Public method
Equals(Object)
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.)
Public method
Equals(AFObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.)
Public methodStatic member
FindModels
Performs a non-paged text search within the AFDatabase to retrieve a collection of AFModel objects which have a field that match the specified query string.
Public method
GetAnalyses Obsolete.
Retrieves a collection of AFAnalysis objects that target this element.
(Inherited from AFElement.)
Public method
GetAnnotations
Retrieves a collection of existing AFAnnotation objects belonging to this AFBaseElement.
(Inherited from AFBaseElement.)
Public method
GetAttributeByTrait
Retrieves the child AFAttribute with the specified AFAttributeTrait.
(Inherited from AFBaseElement.)
Public method
GetAttributesByTrait
Retrieves a list of child AFAttribute objects identified by the specified list of attribute traits.
(Inherited from AFBaseElement.)
Public method
GetConnectedElements(AFElement)
This method returns a collection of AFElement objects which are connected to the specified element (or child element) within the model.
Public method
GetConnectedElements(AFElement, AFPortType)
This method returns a collection of AFElement objects which are connected to the specified element (or child element) through a port of the specified type within the model.
Public method
GetConnectedElements(AFElement, String)
This method returns a collection of AFElement objects which are connected to the specified element and port within the model.
Public method
GetConnections(AFElement)
This method returns a collection of AFConnection objects representing a connection between the specified element (or child element) and another element within the model.
Public method
GetConnections(AFElement, AFPortType)
This method returns a collection of AFConnection objects with the specified port type representing a connection between the specified element (or child element) and another element within the model.
Public method
GetConnections(AFElement, String)
This method returns a collection of AFConnection objects with the specified port name representing a connection between the specified element and another element within the model.
Public method
GetElements(AFSortField, AFSortOrder, Int32) Obsolete.
Retrieves a non-paged collection of child AFElement objects that have been added to this element.
(Inherited from AFElement.)
Public method
GetElements(AFSortField, AFSortOrder, Int32, Int32, Int32) Obsolete.
Retrieves a paged collection of child AFElement objects that have been added to this element.
(Inherited from AFElement.)
Public method
GetEventFrames(Object, Int32, Int32, AFEventFrameSearchMode, String, AFCategory, AFElementTemplate) Obsolete.
Retrieves a paged collection of AFEventFrame objects that reference this element limited to the specified count beginning at the requested start time in the specified direction.
(Inherited from AFElement.)
Public method
GetEventFrames(AFSearchMode, Object, Object, String, AFCategory, AFElementTemplate, AFSortField, AFSortOrder, Int32, Int32) Obsolete.
Retrieves a paged collection of AFEventFrame objects that reference this element within the specified time range.
(Inherited from AFElement.)
Public method
GetHashCode
Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from AFObject.)
Public method
GetLayers
This method returns a collection of AFLayer objects for the specified element representing all the layers of the model which contain the element.
Public method
GetNotifications
Retrieves a collection of AFNotification objects that target this element.
(Inherited from AFElement.)
Public method
GetParents(AFSortField, AFSortOrder, Int32)
Retrieves a non-paged collection of AFElement objects that reference this element.
(Inherited from AFElement.)
Public method
GetParents(AFCategory, AFSortField, AFSortOrder, Int32)
Retrieves a non-paged collection of AFElement objects that reference this element using the specified AFCategory.
(Inherited from AFElement.)
Public method
GetParents(AFReferenceType, AFSortField, AFSortOrder, Int32)
Retrieves a non-paged collection of AFElement objects that reference this element using the specified AFReferenceType.
(Inherited from AFElement.)
Public method
GetParents(AFSortField, AFSortOrder, Int32, Int32, Int32)
Retrieves a paged collection of AFElement objects that reference this element.
(Inherited from AFElement.)
Public method
GetParents(AFCategory, AFSortField, AFSortOrder, Int32, Int32, Int32)
Retrieves a paged collection of AFElement objects that reference this element using the specified AFCategory.
(Inherited from AFElement.)
Public method
GetParents(AFReferenceType, AFSortField, AFSortOrder, Int32, Int32, Int32)
Retrieves a paged collection of AFElement objects that reference this element using the specified AFReferenceType.
(Inherited from AFElement.)
Public method
GetPath
Returns the full path to the object, using just the names.
(Inherited from AFObject.)
Public method
GetPath(AFObject)
Returns the path to the object relative from another object.
(Inherited from AFObject.)
Public method
GetPath(AFEncodeType, AFObject)
Returns the path to the object relative from another object, using the name and/or id as specified by encodeType.
(Inherited from AFObject.)
Public method
GetPaths
Get all the full paths to this AFElement.
(Inherited from AFElement.)
Public method
GetPaths(String)
Get all the relative paths to this AFElement.
(Inherited from AFElement.)
Public method
GetReferenceTypes
Retrieves a collection of all AFReferenceType objects that represent types of references from this element to its child elements.
(Inherited from AFElement.)
Public method
GetReferenceTypes(AFElement)
Retrieves a collection of AFReferenceType objects that represent types of references between this element and the specified related element.
(Inherited from AFElement.)
Public method
GetSecurity
Gets the AFSecurity information of the specified security item associated with the object.
(Inherited from AFElement.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IsTypeOf
Checks if the current AFBaseElement is derived from the specified AFElementTemplate.
(Inherited from AFBaseElement.)
Public method
Persist
This method returns the persistence string for the object.
(Inherited from AFObject.)
Public method
Refresh
Refreshes the client with any changes that have been made to the object since loaded.
(Inherited from AFElement.)
Public method
ToString
Returns a String that represents the current object.
(Inherited from AFObject.)
Public method
UndoCheckOut
This method discards all the changes to the object and all sub-objects since the last call to CheckOut. Any changes since the check out will be lost.
(Inherited from AFElement.)

See Also

TitleResults for “How to create a CRG?”Also Available in