[This is preliminary documentation and is subject to change.]
This is a multi value struct generated from the flag set data class
in the Persistate system definition file.
Declaration Syntax| C# |
public struct FlagSet : IMultiValue
Members| All Members | Constructors | Methods | Properties | Fields | |
| Icon | Member | Description |
|---|---|---|
 | FlagSet(Int32) | Creates a new FlagSet from an integer value. |
| AllClear(FlagSet) | Determines whether all of a set of flags are clear in this
FlagSet. |
  | AllowOrder | This is the value for allow order. |
| AllSet(FlagSet) | Determines whether all of a set of flags are set in this
FlagSet. |
| AnyClear(FlagSet) | Determines whether any of a set of flags is clear in this
FlagSet. |
| AnySet(FlagSet) | Determines whether any of a set of flags is set in this
FlagSet. |
| Associated | This is the value for associated. |
| Attached | This is the value for attached. |
| Clear(FlagSet) | Clears one or more flags in the FlagSet. Any flags supplied which
are already clear are unaffected. Other flags are unaffected. |
| CloneOnMutate | This is the value for clone on mutate. |
| Deleted | This is the value for deleted. |
| Discriminative | This is the value for discriminative. |
| Distinctive | This is the value for distinctive. |
| Distributed | This is the value for distributed. |
| Diverse | This is the value for diverse. |
| Empty | This is the default FlagSet value. |
| Equals(Object) | Performs an equality comparison with another object. (Overrides ValueType.Equals(Object).) |
 | ExplicitNarrowingExplicitExplicitExplicit(FlagSet to String) | Explicit conversion from FlagSet to string. |
 | Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| GetHashCode()()()() | Creates a hash code for the FlagSet. (Overrides ValueType.GetHashCode()()()().) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| HasField | This is the value for has field. |
| ImplicitWideningImplicitImplicitImplicit(FlagSet to Int32) | Implicit conversion from FlagSet to int. |
| ImplicitWideningImplicitImplicitImplicit(Int32 to FlagSet) | Implicit conversion from int to FlagSet. |
| ImplicitWideningImplicitImplicitImplicit(String to FlagSet) | Implicit conversion from string to FlagSet. |
| Invalid | This is the value for invalid. |
 | IsCombinable | Indicates whether FlagSet values can be combined. |
| KeepVersions | This is the value for keep versions. |
| LogAssociations | This is the value for log associations. |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| Modified | This is the value for modified. |
| MultipleMany | This is the value for multiple many. |
| MultipleObject | This is the value for multiple object. |
| Nominative | This is the value for nominative. |
| Optional | This is the value for optional. |
| Ordered | This is the value for ordered. |
| ordinal | Contains the value of the FlagSet. |
| Ordinal | Gets the integer ordinal value of this FlagSet. |
| Orphan | This is the value for orphan. |
| Parse(String) | Parses a string containing a textual representation of an FlagSet. |
| Primary | This is the value for primary. |
| ReadLock | This is the value for read lock. |
| ReadOnly | This is the value for read only. |
| Reserved | This is the value for reserved. |
| SaveInConfiguration | This is the value for save in configuration. |
| Secured | This is the value for secured. |
| Set(FlagSet) | Sets one or more flags in the FlagSet. Any flags supplied which
are already set are unaffected. Other flags are unaffected. |
| Singleton | This is the value for singleton. |
| sourcePairs | This array contains one source pair for each FlagSet value. |
| SourcePairs | Gets the array of ISourcePairs holding ordinal and text values. |
| TopValue | This is the value for the top value. |
| ToString()()()() | Creates a textual representation of the FlagSet. (Overrides ValueType.ToString()()()().) |
| UseCache | This is the value for use cache. |
| UseLinkTable | This is the value for use link table. |
| Volatile | This is the value for volatile. |
| WriteLock | This is the value for write lock. |
Remarks FlagSets are single 32 bit quantities which contain several
overlapping sets of flags used in different classes. These latter are Member, IndexedList, ObjectClass, ClassCategory and Persistent. In most circumstances you will not need
to deal with these flags directly, but some methods are available to
manipulate them.