EcmDocumentRouterRule.ConditionsString property

  • Article

Gets or sets the XML string representing the conditions that must be matched for this rule to execute.

Namespace:  Microsoft.Office.RecordsManagement.RecordsRepository
Assembly:  Microsoft.Office.Policy (in Microsoft.Office.Policy.dll)

Syntax

'Declaration
Public Property ConditionsString As String
    Get
    Set
'Usage
Dim instance As EcmDocumentRouterRule
Dim value As String

value = instance.ConditionsString

instance.ConditionsString = value

public string ConditionsString { get; set; }

Property value

Type: System.String

Remarks

Conditions configured for this rule determine whether the document is organized by this rule.

For a rule to organize a document into a library within the site or to another location, the metadata associated with the document must match the conditions defined by the rule. Each condition operates on a property of the rule's content type. The conditions of a rule are well-formed XML defined by:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexType name="Conditions">
      <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="5" name="Condition">
            <xs:complexType>
               <xs:element minOccurs="1" maxOccurs="1" name="Column" type="xs:string" />
               <xs:element minOccurs="1" maxOccurs="1" name="Operator">
                  <xs:simpleType>
                     <xs:restriction base="xs:string">
                        <xs:enumeration value="IsEqual" />
                        <xs:enumeration value="IsNotEqual" />
                        <xs:enumeration value="GreaterThan" />
                        <xs:enumeration value="LessThan" />
                        <xs:enumeration value="GreaterThanOrEqual" />
                        <xs:enumeration value="LessThanOrEqual" />
                        <xs:enumeration value="BeginsWith" />
                        <xs:enumeration value="NotBeginsWith" />
                        <xs:enumeration value="EndsWith" />
                        <xs:enumeration value="NotEndsWith" />
                        <xs:enumeration value="Contains" />
                        <xs:enumeration value="NotContains" />
                        <xs:enumeration value="EqualsOrIsAChildOf" />
                        <xs:enumeration value="NotEqualsOrIsAChildOf" />
                        <xs:enumeration value="IsEmpty" />
                        <xs:enumeration value="IsNotEmpty" />
                        <xs:enumeration value="ContainsAny" />
                        <xs:enumeration value="ContainsAnyOrChildOf" />
                        <xs:enumeration value="ContainsAllOrChildOf" />
                     </xs:restriction>
                  </xs:simpleType>
               </xs:element>
               <xs:element minOccurs="1" maxOccurs="1" name="Value"type="xs:string"/>
            </xs:complexType>
         </xs:element>
      </xs:sequence>
   </xs:complexType>

Column: A string representing the field on which the condition is based. The value of the column element must be in the format: field id|field internal name|field title where field id is the GUID for the SPField, field internal name is the InternalName property of the SPField, and field title is the Title property of the SPField. User (User), URL (URL), calculated (Calculated), hidden, and read-only fields are not valid fields for conditions.

Operator: Operators supported for a field depend upon the type (SPFieldType) of the field used in the condition. Fields of Boolean type support only the IsEqual and IsNotEqual operators.

Value: The field value used when evaluating this rule on an incoming document. This is used as an operand if a binary operator is used.

See also

Reference

EcmDocumentRouterRule class

EcmDocumentRouterRule members

Microsoft.Office.RecordsManagement.RecordsRepository namespace