EcmDocumentRouterRuleCollection EcmDocumentRouterRuleCollection EcmDocumentRouterRuleCollection Class

Definition

Represents the collection of rules that are used by the content organizer to organize submitted documents.

public ref class EcmDocumentRouterRuleCollection : System::Collections::Generic::ICollection<Microsoft::Office::RecordsManagement::RecordsRepository::EcmDocumentRouterRule ^>, System::Collections::Generic::IEnumerable<Microsoft::Office::RecordsManagement::RecordsRepository::EcmDocumentRouterRule ^>
public class EcmDocumentRouterRuleCollection : System.Collections.Generic.ICollection<Microsoft.Office.RecordsManagement.RecordsRepository.EcmDocumentRouterRule>, System.Collections.Generic.IEnumerable<Microsoft.Office.RecordsManagement.RecordsRepository.EcmDocumentRouterRule>
Public Class EcmDocumentRouterRuleCollection
Implements ICollection(Of EcmDocumentRouterRule), IEnumerable(Of EcmDocumentRouterRule)
Inheritance
EcmDocumentRouterRuleCollectionEcmDocumentRouterRuleCollectionEcmDocumentRouterRuleCollection
Implements

Remarks

Each EcmDocumentRouterRule object specifies the final location for documents of a specific content type. Optionally, the rule may also place additonal requirements on the metadata of the document so that the document will be routed to the location specified by the rule. The EcmDocumentRoutingRuleCollection contains all of the rules specified for a SPWeb object that has the content organizer enabled.

When a document is submitted to an EcmDocumentRoutingWeb object, all Enabled in the site are evaluated in the order of Priority to determine the final location for the document.

Properties

Count Count Count

Gets the number of EcmDocumentRouterRule objects in the EcmDocumentRouterRuleCollection object.

IsReadOnly IsReadOnly IsReadOnly

Gets whether the collection can be modified.

Item[Int32] Item[Int32] Item[Int32]

Gets or sets the EcmDocumentRouterRule at the specified index.

Methods

Add(EcmDocumentRouterRule) Add(EcmDocumentRouterRule) Add(EcmDocumentRouterRule)

Adds the specified EcmDocumentRouterRule object to the collection of rules in an EcmDocumentRoutingWeb object.

Clear() Clear() Clear()

Not implemented.

Contains(EcmDocumentRouterRule) Contains(EcmDocumentRouterRule) Contains(EcmDocumentRouterRule)

Lists the rules that the specified SPList contains.

CopyTo(EcmDocumentRouterRule[], Int32) CopyTo(EcmDocumentRouterRule[], Int32) CopyTo(EcmDocumentRouterRule[], Int32)

Copies the EcmDocumentRouterRule.

CreateRule() CreateRule() CreateRule()

Not supported.

CreateRuleCopy(EcmDocumentRouterRule) CreateRuleCopy(EcmDocumentRouterRule) CreateRuleCopy(EcmDocumentRouterRule)

Creates a copy of an EcmDocumentRouterRule in the collection of rules for EcmDocumentRoutingWeb.

GetEnumerator() GetEnumerator() GetEnumerator()

Gets an enumeration of EcmDocumentRouterRule object from the EcmDocumentRouterRuleCollection object.

IsTargetLibrary(String) IsTargetLibrary(String) IsTargetLibrary(String)

Used to determine if a URL is specified as a final location by a rule in the EcmDocumentRoutingWeb object.

Remove(EcmDocumentRouterRule) Remove(EcmDocumentRouterRule) Remove(EcmDocumentRouterRule)

Removes the specified EcmDocumentRouterRule object from the EcmDocumentRouterRuleCollection object.

RemoveAt(Int32) RemoveAt(Int32) RemoveAt(Int32)

Removes a EcmDocumentRouterRule object from the EcmDocumentRouterRuleCollection object.

Explicit Interface Implementations

IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() IEnumerable.GetEnumerator()

The IEnumerator instance required for the IEnumerable interface.

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)

Applies to