DocumentIdProvider.GetSampleDocumentIdText Method

Returns the default Document ID value that will be initially displayed in the Document ID search web part.

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

Syntax

'Declaration
Public MustOverride Function GetSampleDocumentIdText ( _
    site As SPSite _
) As String
'Usage
Dim instance As DocumentIdProvider
Dim site As SPSite
Dim returnValue As String

returnValue = instance.GetSampleDocumentIdText(site)

public abstract string GetSampleDocumentIdText(
    SPSite site
)

Parameters

• site
  Type: Microsoft.SharePoint.SPSite

  An SPSite object that specifies the site in which the web part is located.

Return Value

Type: System.String
A string representing the default Document ID value that will be initially displayed in the Document ID search web part.

See Also

Reference

DocumentIdProvider Class

DocumentIdProvider Members

Microsoft.Office.DocumentManagement Namespace