FCGeneric Class Members
The following tables list the members exposed by FCGeneric.
Public Fields
Name | Description | |
---|---|---|
MAX_DATE | Maximum possible date that is allowed to be entered for a date field. | |
MIN_DATE | Minimum possible date that is allowed to be entered for a date field. | |
NOW_DATE | When date fields are set to this value the current server datetime will be entered instead. |
Public Properties
| | Name | Description | | --- | --- | --- | | | ChildGenerics | Returns a dictionary (keyed by parent to child relation name) of child generics belonging to this FCGeneric. | | | Count | Returns the number of rows currently populated by the Query or AddNew methods. | | | DataFields | Collection of data fields that will be returned when Query is invoked. If no fields are selected all fields are returned. | | | DataRestrictionsEnabled | Sets whether or not this FCGeneric will have the DataRestrictions feature enabled if available.
| | | DeleteRelationsToUnrelate | | | | 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. | | | IncludeRelations | Queries will retrieve all relation fields for the Generic | | | IsDistinct | Is this a Generic that should query for only discinct rows. | | | IsSynchronized | Gets a value indicating whether access to the FCGeneric is synchronized (thread-safe). | | | MaximumRows | Controls the maximum number of rows to be returned by the Genric Query. | | | 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.
| | | RawFilter |
Sets an optional WHERE clause constraint. (WARNING: See remarks for potential security implications)
| | | RestrictionGroup | Override the Session Data Restriction Group of this Generic. The ChangeRestrictionGroup method is available as a helper. | | | SearchableFieldPrefix | | | | SetNullStringsToEmpty | Sets whether or not this FCGeneric will convert a null reference (Nothing in Visual Basic) to empty strings. | | | SyncRoot | Gets an object that can be used to synchronize access to the FCGeneric. | | | TableName | Returns the name of the database table this FCGeneric is based on. |
Public Methods
Name | Description | |
---|---|---|
AppendFilter | Overloaded. Adds a filter to constrain the results of an FCGeneric Query against a numeric DataField. | |
AppendFilterBetween | Overloaded. Adds a specialized filter to constrain the results of an FCGeneric Query to be between two Integer values. | |
AppendFilterInList | Overloaded. Adds a filter to constrain the results of an FCGeneric Query against a list of possible Integer values**.** | |
AppendFilterIsNull | Adds a filter to constrain the results of an FCGeneric Query against NULL or NOT NULL fields. | |
AppendSort | Overloaded. Adds a field by which the results of an FCGeneric Query will be sorted. | |
AssignObjID | ||
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. | |
ClearFilters | Clears all filters that have been appended to this generic. | |
ClearSorts | Clears all sort operations that have been appended to this generic. | |
CopyTo | Copies all the rows of the current FCGeneric into to a one-dimensional Array. | |
DeleteAll | Delete all rows present in this FCGeneric. | |
GetEnumerator | Returns an IEnumerator for the FCGeneric. | |
Query | Overloaded. Causes the generic object to query the database table or view using the optionally specified data fields, filters, and sort orders | |
Update | Overloaded. Updates changes to a single GenericDataRow | |
UpdateAll | Overloaded. Updates all modified rows of the 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. |