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

AF SDK Reference

TABLE OF CONTENTS

AFEnumerationSet Methods

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedNov 18, 2025
  • 9 minute read
AFEnumerationSet Methods

The AFEnumerationSet type exposes the following members.

Methods

  NameDescription
Public method
Add(AFEnumerationValue)
The Add method adds the specified AFEnumerationValue to the AFEnumerationSet.
Public method
Add(String, Int32)
The Add method creates a new AFEnumerationValue and adds it to the collection with the specified name and value.
Public methodCode example
ApplyChanges
This method applies the changes to the object and makes those changes available to other objects for the current user.
Public method
AreEquivalent
This method compares two AFEnumerationSet objects for equivalence.
Public methodCode example
CheckIn
This method checks in (commits) all the changes to the object by saving the information to persistent storage.
Public method
CheckOut
This method locks the object so that its configuration can be modified.
Public methodStatic member
CheckOutEnumerationSets
Check out the objects with the specified unique identifiers at the specified query date.
Public method
Clear
Removes all items from the collection.
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 method
Contains(Guid)
This method determines whether the collection contains a specific item referenced by id.
Public method
Contains(Int32)
This method determines whether the collection contains a specific item value.
Public method
Contains(String)
This method determines whether the collection contains a specific item referenced by name.
Public method
Contains(AFEnumerationValue)
This method determines whether the collection contains a specific item.
Public method
CopyTo
Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
Public methodStatic member
DeleteEnumerationSets
Delete the objects with the specified unique identifiers.
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
FindEnumerationSet
Retrieves the AFEnumerationSet object with the specified unique identifier.
Public methodStatic member
FindEnumerationSets(PISystem, Guid)
Performs a search within the PISystem to retrieve a collection of AFEnumerationSet objects with the specified list of unique identifiers.
Public methodStatic member
FindEnumerationSets(AFDatabase, String, AFSearchField, AFSortField, AFSortOrder, Int32)
Performs a non-paged text search within the AFDatabase to retrieve a collection of AFEnumerationSet objects which have a field that match the specified query string.
Public methodStatic member
GetBySystemStateCode
Gets the specified AFEnumerationValue from the SystemStateSet collection by its AFSystemStateCode.
Public method
GetByValue
Gets the specified AFEnumerationValue from the collection by its value.
Public method
GetEnumerator
Returns an enumerator that iterates through the collection.
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
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
GetSecurity
Gets the AFSecurity information of the specified security item associated with the object.
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire collection.
Public methodStatic member
LoadEnumerationSets(IListAFEnumerationSet)
Loads the specified list AFEnumerationSet objects.
Public methodStatic member
LoadEnumerationSets(PISystem, Guid)
Loads the AFEnumerationSet objects with the specified unique identifiers.
Public method
Persist
This method returns the persistence string for the object.
(Overrides AFObjectPersist.)
Public method
Refresh
Refreshes the client with any changes that have been made to the object since loaded.
Public method
Remove(Guid)
Removes the item with the specified id from the collection.
Public method
Remove(Int32)
The Remove method removes the item from the collection by its value.
Public method
Remove(String)
The Remove method removes the item from the collection by name.
Public method
Remove(AFEnumerationValue)
Removes the first occurrence of a specific object from the collection.
Public method
RemoveAt
Removes the item at the specified index of the collection.
Public method
Sort
Sorts the items in the entire collection using the default comparer.
Public method
Sort(IComparerAFEnumerationValue)
Sorts the items in the entire collection using the specified comparer.
Public method
Sort(Int32, Int32, IComparerAFEnumerationValue)
Sorts the items in a range of items in the collection using the specified comparer.
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.

Extension Methods

  NameDescription
Public Extension Method
AggregateAFEnumerationValue
Performs all requested aggregates on the specified items.
(Defined by AFAggregate.)
Public Extension Method
AggregateAsyncAFEnumerationValue
Performs all requested aggregates on the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
BinnedSummaryAFEnumerationValue, TBin
Generates a summary broken down by the specified bins for items matching the search criteria.
(Defined by AFAggregate.)
Public Extension Method
BinnedSummaryAsyncAFEnumerationValue, TBin
Generates a summary broken down by the specified bins for items matching the search criteria asynchronously.
(Defined by AFAggregate.)
Public Extension MethodCode example
ChunkedByAFEnumerationValue
This extension method breaks up search results into chunks to make it easier to page through and process IEnumerableT collections in chunks.
(Defined by AFSDKExtension.)
Public Extension Method
FrequencyDistributionAFEnumerationValue
Generates a frequency distribution for the specified items.
(Defined by AFAggregate.)
Public Extension Method
FrequencyDistributionAsyncAFEnumerationValue
Generates a frequency distribution for the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
GroupedSummaryAFEnumerationValue
Generates a summary broken down by group for the specified items.
(Defined by AFAggregate.)
Public Extension Method
GroupedSummaryAsyncAFEnumerationValue
Generates a histogram for the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
HistogramAFEnumerationValue, TBin
Generates a histogram for the specified items with the specified weighting.
(Defined by AFAggregate.)
Public Extension Method
HistogramAsyncAFEnumerationValue, TBin
Generates a histogram for the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.)
Public Extension Method
SummaryAFEnumerationValue(String, AFSummaryTypes)Overloaded.
Summarizes the specified items.
(Defined by AFAggregate.)
Public Extension Method
SummaryAFEnumerationValue(String, AFSummaryTypes, String)Overloaded.
Summarizes the specified items with the specified weighting.
(Defined by AFAggregate.)
Public Extension Method
SummaryAsyncAFEnumerationValue(String, AFSummaryTypes, CancellationToken)Overloaded.
Summarizes the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
SummaryAsyncAFEnumerationValue(String, AFSummaryTypes, String, CancellationToken)Overloaded.
Summarizes the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.)

See Also

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