DocumentIdProvider.DoCustomSearchBeforeDefaultSearch Property

Gets a Boolean value specifying whether the current instance of the provider custom search method (GetDocumentUrlsById()) should be called before built-in search is called when the user is trying to locate a document by its DocumentId value.

Namespace:  Microsoft.Office.DocumentManagement
Assembly:  Microsoft.Office.DocumentManagement (in Microsoft.Office.DocumentManagement.dll)

Syntax

'Declaration
Public MustOverride ReadOnly Property DoCustomSearchBeforeDefaultSearch As Boolean
    Get
'Usage
Dim instance As DocumentIdProvider
Dim value As Boolean

value = instance.DoCustomSearchBeforeDefaultSearch
public abstract bool DoCustomSearchBeforeDefaultSearch { get; }

Property Value

Type: System.Boolean
true if the provider custom search method (GetDocumentUrlsById) should be called before built-in search; otherwise, false.

Remarks

Set this property to true when using [GetDocumentUrlsById] is more efficient than using the default search is when locating a document by its Document ID.

See Also

Reference

DocumentIdProvider Class

DocumentIdProvider Members

Microsoft.Office.DocumentManagement Namespace

GetDocumentUrlsById(SPSite, String)