IDocumentConverterControl.RequiresConfiguration property
NOTE: This API is now obsolete.
Gets a value that determines whether this document converter requires configuration.
Namespace: Microsoft.SharePoint.Publishing
Assembly: Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)
Syntax
'Declaration
<ObsoleteAttribute("This interface is obsolete - use the specialized Office services instead for conversions", _
False)> _
ReadOnly Property RequiresConfiguration As Boolean
Get
'Usage
Dim instance As IDocumentConverterControl
Dim value As Boolean
value = instance.RequiresConfiguration
[ObsoleteAttribute("This interface is obsolete - use the specialized Office services instead for conversions",
false)]
bool RequiresConfiguration { get; }
Property value
Type: System.Boolean
A Boolean value that represents whether this document converter requires configuration.
Remarks
The document-to-page conversion framework uses this property to query the control and determine if it needs to be configured before running a conversion.
The document content type is already set before this property is called. This property is only called if the ConverterSettings string is empty.
The control should use the settings and the content type to determine whether it needs more user input. If the control returns True when the user clicks OK on the configuration page, the document converter configuration and process are blocked until the document converter control returns False or until the ConverterSettings are no longer empty.
See also
Reference
IDocumentConverterControl interface