Share via

SPDocumentConverter members

  • Article

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
Public method SPDocumentConverter() Reserved for internal use.
Public method SPDocumentConverter(Guid, String, SPPersistedObject) Initializes a new instance of the SPDocumentConverter class.

Top

Properties

  Name Description
Public property App Gets the application name of the document converter.
Public property ConverterId Gets or sets the GUID for the document converter.
Public property ConverterSettingsForContentType Gets the URL to the per-content-type converter settings page.
Public property ConverterSpecificSettingsUI Gets a user control that can be loaded and rendered.
Public property ConverterUIPage Gets the file name of the converter page to which users navigate through the context menu.
Public property ConvertFrom Gets the file extension of the source document that the transformer can accept.
Public property ConvertTo Gets the file extension of the target document that the transformer can produce.
Public propertyStatic member DefaultTransformUIPage Gets the default file name of the converter page to which users navigate through the context menu.
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property DisplayInUI Gets or sets a Boolean value that determines whether the document transformer appears in the user interface.
Public property DisplayName Gets the display name of converter relative to the locale. (Overrides SPPersistedObject.DisplayName.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property LanguageCulture Gets or sets the locale to use for the document converter settings.
Public propertyStatic member MaxAllowedFileSize Gets a value that indicates the maximum file size in kilobytes that can be converted.
Public propertyStatic member MaxAllowedRetries Gets the value that determines the maximum number of retries for the document converter.
Public propertyStatic member MaxAllowedTimeout Gets the length of time in seconds that must expire before the conversion times out.
Public property MaxFileSize Gets or sets the maximum file size in kilobytes that the document converter can handle.
Public propertyStatic member MinAllowedFileSize Gets the minimum file size in kilobytes that the document converter can handle.
Public propertyStatic member MinAllowedRetries Gets the value that determines the minimum number of retries for the document converter.
Public propertyStatic member MinAllowedTimeout Gets the minimum length of time in seconds that is required by the document converter.
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public propertyStatic member NoFileSizeLimit Gets a value that indicates there is no file size limit for the document converter.
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property Retries Gets or sets the maximum number or retries for the document converter.
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property Timeout Gets or sets the timeout length for the document converter.
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property 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
Public method 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.)
Public method Delete Deletes the object. (Inherited from SPPersistedObject.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method SupportsFile Returns a Boolean value that indicates whether the document converter supports transformation of the specified file.
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Causes the object to save its state and propagate changes to all the computers in the server farm. (Inherited from SPPersistedObject.)
Public method 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.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
Public methodStatic member ValidateFileSize Verifies that the specified file size remains within the limits set by the MinAllowedFileSize and MaxAllowedFileSize properties.
Public methodStatic member ValidateRetries Verifies that the specified number of retries remains within the limits set by the MinAllowedRetries and MaxAllowedRetries properties.
Public methodStatic member 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