Grooper.CMIS.ScopePredicate
Restricts the search scope to the children or descendants of a folder.
A Scope Predicate takes the form IN_FOLDER(FolderId) or IN_TREE(FolderId).
IN_FOLDER only matches items which are direct children of the base folder, while IN_TREE matches all descendants of the base folder at any level.
For example, the following query can be used with the NTFS binding to target PDF files which are immediate children of the '/Import/Faxes' folder:
SELECT * FROM File WHERE IN_FOLDER(/Import/Faxes) AND FileExtension='.pdf'
As another example, the following query can be used with the Exchange binding to target emails which contain 'Grooper' in the subject, in the Inbox
folder or any subfolder:
SELECT * FROM Message WHERE IN_TREE(/Inbox) AND Subject LIKE '%grooper%'
Inherits from: Grooper.CMIS.WherePredicate
Constructors
| Signature |
Description |
| New (FolderId As String, IncludeSubfolders As Boolean, Inverted As Boolean) |
| Parameters |
| FolderId |
| Type: String |
| |
| |
| IncludeSubfolders |
| Type: Boolean |
| |
| |
| Inverted |
| Type: Boolean |
| |
|
Fields
| Field Name |
Field Type |
Description |
| FolderId As System.String |
System.String |
|
| IncludeSubfolders As System.Boolean |
System.Boolean |
|
| Inverted As System.Boolean |
System.Boolean |
|
Properties
| Property Name |
Property Type |
Description |
| IsEmpty |
System.Boolean |
Returns true if all properties with a ViewableAttribute are set to their default value. |
| IsWriteable |
System.Boolean |
Returns true if the object is writable, or false if it is not. |
Methods
| Method Name |
Description |
| GetInvertedValue(Value As Boolean) As Boolean |
Returns the inverse of the passed Boolean value, if this query element's Inverted property is True, otherwise the passed Boolean value is returned.
| Parameters |
| Value |
| Type: Boolean |
| |
|
| GetProperties() As PropertyDescriptorCollection |
|
| IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently enabled.
| Parameters |
| PropertyName |
| Type: String |
| The name of the property to determine the enabled state for. |
|
| IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently visible.
| Parameters |
| PropertyName |
| Type: String |
| The name of the property to determine the visible state for. |
|
| IsType(Type As Type) As Boolean |
Returns true if the object is of the type specified, or if it derives from the type specfied.
| Parameters |
| Type |
| Type: Type |
| The type to check. |
|
| ToString() As String |
|
| ValidateProperties() As ValidationErrorList |
Validates the properties of the object, returning a list of validation errors. |