SavedFilter Properties |
The SavedFilter type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Attributes | The FilterAttributes for the filter. |
| CreateDate | The UTC date/time at which the filter was created. |
| CreatorID | The creator of the filter. |
| Criteria | The criteria use to create the filter. This XML stores criteria
information that can be used to maintain the filter. |
| Description |
The localized description of the filter.
A more verbose description is available from VerboseDescription.
|
| EndDate | The optional UTC date/time at which the filter expires. See also StartDate. |
| Filter | The SQL filter clause for the filter. Note that for true static filters
the filter clause will a subquery against the xot_saved_filter_keys table. |
| From |
The SQL FROM clause (typically a table or view name) for which the filter is intended.
|
| FullTextSearchValue |
The fulltext search value for this filter. Used in conjunction with FullTextTable.
|
| FullTextTable |
The fulltext table for this filter. Used in conjunction with FullTextSearchValue.
|
| ID | The unique (GUID) ID for the filter.
The ID serves as the key in the SavedFilters collection. |
| KeyColumn |
The column in the underlying table containing the single primary key uniquely
identifying a row in the table. This key is used in filter clause building.
|
| KeyCount |
Gets the number of keys for this static (Static) filter. If the
filter is not static, or the number of keys cannot be determined, -1 is returned. Note that,
for performance reasons, KeyCount is preferred over flt.Keys.Count
if no other use of the Keys collection is being made because accessing the Keys
collection will cause the keys collection to be loaded if it was not already loaded.
|
| Keys |
The list of keys for a static filter. If the filter is not marked Static then
an empty set will be returned. Note that accessing the Keys collection on a static filter will
cause the collection to be loaded from the xot_saved_filter_keys table. For improved performance, if
the Keys collection is being accessed solely to get the count, use KeyCount which
will not cause the collection to be loaded.
|
| KeysLoaded |
Gets/Sets a boolean value that indicates if the Keys for this filter have been loaded.
|
| LocaleKey | The locale of the base filter. Note that if localized text
is available for the filter it will be used in place of the original,
non-localized text from this locale. |
| ModuleKey | The module to which this filter belongs. |
| Moniker | The pseudo-unique moniker for the filter. Ideally, this should be unique within
the SavedFilters collection, but is not guaranteed to be so. |
| MOP | The module to which this filter belongs. |
| Name | The localized, natural language name of the filter. |
| OwnerID | The owner (if any) of the filter. If no owner is specified then the
filter is globally available. |
| PageElementID |
Gets/sets the PageElementID for the PageElementInfo for this filter.
This should be set only when the filter is specific to the specified page element.
|
| PreFilter | The SQL PreFilter clause for the filter. |
| Sort | The sort clause for the filter, if any. |
| StartDate | The optional UTC date/time from which the filter is valid. See also EndDate. |
| TenantId |
The Tenant ID for this filter. Tenant may be NULL.
|
| Usage |
Gets/sets the filter Usage. The Usage can be used to correlate a filter with a certain set of functionality.
You can use UsageSpecific to restrict visibility of the filter.
|
| VerboseDescription |
The localized verbose description for this filter.
A more succinct description is available from Description.
|
See Also