SPDocumentConverter Members

Include Protected Members
Include Inherited Members

Represents a document converter, or document transformer, that is installed in a SharePoint Web application.

The SPDocumentConverter type exposes the following members.

Constructors

	Name	Description
	SPDocumentConverter()	Reserved for internal use.
	SPDocumentConverter(Guid, String, SPPersistedObject)	Initializes a new instance of the SPDocumentConverter class.

Top

Properties

	Name	Description
	App	Gets the application name of the document converter.
	ConverterId	Gets or sets the GUID for the document converter.
	ConverterSettingsForContentType	Gets the URL to the per-content-type converter settings page.
	ConverterSpecificSettingsUI	Gets a user control that can be loaded and rendered.
	ConverterUIPage	Gets the file name of the converter page to which users navigate through the context menu.
	ConvertFrom	Gets the file extension of the source document that the transformer can accept.
	ConvertTo	Gets the file extension of the target document that the transformer can produce.
	DefaultTransformUIPage	Gets the default file name of the converter page to which users navigate through the context menu.
	DisplayInUI	Gets or sets a Boolean value that determines whether the document transformer appears in the user interface.
	DisplayName	Gets the display name of converter relative to the locale. (Overrides SPPersistedObject.DisplayName.)
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	LanguageCulture	Gets or sets the locale to use for the document converter settings.
	MaxAllowedFileSize	Gets a value that indicates the maximum file size in kilobytes that can be converted.
	MaxAllowedRetries	Gets the value that determines the maximum number of retries for the document converter.
	MaxAllowedTimeout	Gets the length of time in seconds that must expire before the conversion times out.
	MaxFileSize	Gets or sets the maximum file size in kilobytes that the document converter can handle.
	MinAllowedFileSize	Gets the minimum file size in kilobytes that the document converter can handle.
	MinAllowedRetries	Gets the value that determines the minimum number of retries for the document converter.
	MinAllowedTimeout	Gets the minimum length of time in seconds that is required by the document converter.
	Name	Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
	NoFileSizeLimit	Gets a value that indicates there is no file size limit for the document converter.
	Parent	Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
	Properties	Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
	Retries	Gets or sets the maximum number or retries for the document converter.
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	Timeout	Gets or sets the timeout length for the document converter.
	TypeName	Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
	UpgradedPersistedProperties	Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
	Version	Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
	WasCreated	Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)

Top

Methods

	Name	Description
	Clone	Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
	Delete	Deletes the object. (Inherited from SPPersistedObject.)
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	Finalize	(Inherited from Object.)
	GetChild<T>()	Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
	GetChild<T>(String)	Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
	GetHashCode	Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
	GetObjectData	Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
	GetType	(Inherited from Object.)
	HasAdditionalUpdateAccess	Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
	MemberwiseClone	(Inherited from Object.)
	OnDeserialization	Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
	Provision	Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
	SupportsFile	Returns a Boolean value that indicates whether the document converter supports transformation of the specified file.
	ToString	Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
	Uncache	Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
	Unprovision	Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
	Update()	Causes the object to save its state and propagate changes to all the computers in the server farm. (Inherited from SPPersistedObject.)
	Update(Boolean)	Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
	UpdateParent	Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
	Validate	Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
	ValidateFileSize	Verifies that the specified file size remains within the limits set by the MinAllowedFileSize and MaxAllowedFileSize properties.
	ValidateRetries	Verifies that the specified number of retries remains within the limits set by the MinAllowedRetries and MaxAllowedRetries properties.
	ValidateTimeout	Verifies that the specified timeout length remains within the limits set by the MinAllowedTimeout and MaxAllowedTimeout properties.

Top

See Also

Reference

SPDocumentConverter Class

Microsoft.SharePoint.Administration Namespace