ClarifyGeneric Class Members
The following tables list the members exposed by ClarifyGeneric.
Public Fields
Name | Description | |
---|---|---|
![]() ![]() |
GuidColumnName |
Public Properties
Name | Description | |
---|---|---|
![]() |
ChildGenerics | Gets an IDictionary of associated child generics keyed by their relation from the parent (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
Count | Returns the number of rows currently populated by the Query or AddNew methods. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
DataFields | Collection of data fields that will be returned when Query is invoked. If no fields are selected all fields are returned. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
DataRestrictionsEnabled | |
Sets whether or not this FCGeneric will have the DataRestrictions feature enabled if available. (Inherited from FChoice.Foundation.FCGeneric) | ||
![]() |
DataSet | |
![]() |
DeleteRelationsToUnrelate | (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
Filter | This is the root filter used to constrain rows returned during Query operations. Initially there are no filters present with filters being added using the AddFilter method. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
IncludeRelations | Queries will retrieve all relation fields for the Generic (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
IsDistinct | Is this a Generic that should query for only discinct rows. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
IsSynchronized | Gets a value indicating whether access to the FCGeneric is synchronized (thread-safe). (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
Item | Gets the ClarifyDataRow at the specified index in this ClarifyGeneric |
![]() |
MaximumRows | Controls the maximum number of rows to be returned by the Genric Query. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
ParentGeneric | Gets a reference to the parent ClarifyGeneric if this generic is a child |
![]() |
ParentRelation | Gets a reference to the ISchemaRelation schema object which represents the relation used to traverse from the ParentGeneric |
![]() |
QueryEmptyToNull | Sets whether or not this FCGeneric will convert filters on empty strings into filters on Queries that check IS NULL or IS NOT NULL. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
RawFilter | Sets an optional WHERE clause constraint. (WARNING: See remarks for potential security implications) (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
RestrictionGroup | Override the Session Data Restriction Group of this Generic. The ChangeRestrictionGroup method is available as a helper. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
Rows | Gets a reference to the ClarifyRowCollection which contains all the rows queried for this generic |
![]() |
SchemaTable | |
![]() |
SearchableFieldPrefix | Overridden. |
![]() |
Session | Gets a reference to the parent ClarifySession of this generic. |
![]() |
SetNullStringsToEmpty | Sets whether or not this FCGeneric will convert a null reference (Nothing in Visual Basic) to empty strings. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
SyncRoot | Gets an object that can be used to synchronize access to the FCGeneric. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
TableName | Returns the name of the database table this FCGeneric is based on. (Inherited from FChoice.Foundation.FCGeneric) |
Public Methods
Name | Description | |
---|---|---|
![]() |
AddForUpdate | |
Creates a new row in the ClarifyGeneric with the specified objId which will be used to update an existing row in the database rather than inserting a new one. | ||
![]() |
AddNew | Overloaded. Adds a new row and schedules it for creation in the database when Update is called |
![]() |
AppendFilter | Overloaded. Adds a filter to constrain the results of an FCGeneric Query against a numeric DataField. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
AppendFilterBetween | Overloaded. Adds a specialized filter to constrain the results of an FCGeneric Query to be between two Integer values. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
AppendFilterInList | Overloaded. Adds a filter to constrain the results of an FCGeneric Query against a list of possible Integer values**.** (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
AppendFilterIsNull | Adds a filter to constrain the results of an FCGeneric Query against NULL or NOT NULL fields. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
AppendSort | Overloaded. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
AssignAllObjIDs | |
![]() |
AssignObjID | (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
ChangeRestrictionGroup | Change the Data Restriction Group of this generic instance overriding the Session default. This method is a helper for when you only know the name of the restriction group. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
ClearFilters | Clears all filters that have been appended to this generic. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
ClearSorts | Clears all sort operations that have been appended to this generic. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
CopyTo | Copies all the rows of the current FCGeneric into to a one-dimensional Array. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
DeleteAll | Delete all rows present in this FCGeneric. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
DeleteById | Deletes the row in the table with the specified objid |
![]() |
GetEnumerator | Returns an IEnumerator for the FCGeneric. (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
Query | Overloaded. Overridden. Causes the generic object to query the database table or view using the optionally specified data fields, filters, and sort orders |
![]() |
Traverse | Creates a child generic that is related to this generic through the specified relation |
![]() |
TraverseFromParent | Makes this generic a child that is related to the specified parent generic through the specified relation |
![]() |
TraverseFromRoot | |
![]() |
Update | Overloaded. Updates changes to a single GenericDataRow (Inherited from FChoice.Foundation.FCGeneric) |
![]() |
UpdateAll | Overloaded. Updates all modified rows of the FCGeneric. (Inherited from FChoice.Foundation.FCGeneric) |
Public Events
Name | Description | |
---|---|---|
![]() |
MaximumRowsExceeded | This event is fired when the MaximumRows property is set and a Query operation has returned too many rows. (Inherited from FChoice.Foundation.FCGeneric) |