WordServiceApplication WordServiceApplication WordServiceApplication Class

Definition

Defines a single logical occurrence of the shared Word Automation Services, and is directly derived from the SPIisWebServiceApplication class.

public ref class WordServiceApplication sealed : Microsoft::Office::ConversionServices::Service::ConversionServiceApplication
[Microsoft.Office.Word.Server.Service.WordServiceApplicationBackup]
[System.Runtime.InteropServices.Guid("45D32CBC-1B8E-41B1-9A3B-FD709324A615")]
[System.ServiceModel.ServiceBehavior(Namespace="http://schemas.microsoft.com/office/server/word/2009/08/service")]
public sealed class WordServiceApplication : Microsoft.Office.ConversionServices.Service.ConversionServiceApplication
Public NotInheritable Class WordServiceApplication
Inherits ConversionServiceApplication
Inheritance
Attributes

Remarks

There is one WordServiceApplication object for each Word Automation Services application that a farm administrator creates.

Constructors

WordServiceApplication() WordServiceApplication() WordServiceApplication()

Reserved for internal use.

Properties

AccessRights AccessRights AccessRights Inherited from SPIisWebServiceApplication
AdministrationAccessRights AdministrationAccessRights AdministrationAccessRights Inherited from SPServiceApplication
ApplicationClassId ApplicationClassId ApplicationClassId

Gets the class ID of the service application.

ApplicationPool ApplicationPool ApplicationPool Inherited from SPIisWebServiceApplication
ApplicationVersion ApplicationVersion ApplicationVersion

Gets the version of the service application.

BatchWorkerTimeout BatchWorkerTimeout BatchWorkerTimeout

Gets or sets a value that specifies the maximum length of time that the timer job waits for worker processes to respond when checking their availability.

CanUpgrade CanUpgrade CanUpgrade Inherited from SPPersistedUpgradableObject
Comments Comments Comments Inherited from SPIisWebServiceApplication
ConversionsPerInstance ConversionsPerInstance ConversionsPerInstance

Gets or sets a value that specifies the number of conversions dispatched to each service instance every time the timer job is run.

ConversionTimeout ConversionTimeout ConversionTimeout

Gets or sets a value that specifies how long a conversion job is allowed to execute before the service checks if the job is still running.

Database Database Database

Gets or sets the database used by the service application.

DefaultEndpoint DefaultEndpoint DefaultEndpoint Inherited from SPIisWebServiceApplication
DefaultEndpointName DefaultEndpointName DefaultEndpointName

Gets the name of the initial default endpoint.

(Inherited from ConversionServiceApplication)
DisableBinaryFileScan DisableBinaryFileScan DisableBinaryFileScan

Gets or sets a value that specifies whether binary documents loaded by the service are subject to additional security validation.

DisableEmbeddedFonts DisableEmbeddedFonts DisableEmbeddedFonts

Gets or sets a value that specifies whether to read and use embedded fonts coming from input documents.

DisplayName DisplayName DisplayName Inherited from SPPersistedObject
Endpoints Endpoints Endpoints Inherited from SPIisWebServiceApplication
Farm Farm Farm Inherited from SPPersistedObject
GoldenRatio GoldenRatio GoldenRatio

Golden ratio specifying the recommended maximum ratio of ConversionsPerInstance * TotalActiveProcesses / TimerJobFrequency.Minutes

IBackupRestore.CanRenameOnRestore IBackupRestore.CanRenameOnRestore IBackupRestore.CanRenameOnRestore Inherited from SPIisWebServiceApplication
IBackupRestore.CanSelectForBackup IBackupRestore.CanSelectForBackup IBackupRestore.CanSelectForBackup Inherited from SPIisWebServiceApplication
IBackupRestore.CanSelectForRestore IBackupRestore.CanSelectForRestore IBackupRestore.CanSelectForRestore Inherited from SPIisWebServiceApplication
IBackupRestore.DiskSizeRequired IBackupRestore.DiskSizeRequired IBackupRestore.DiskSizeRequired Inherited from SPIisWebServiceApplication
Id Id Id Inherited from SPPersistedObject
IisVirtualDirectoryPath IisVirtualDirectoryPath IisVirtualDirectoryPath Inherited from SPIisWebServiceApplication
InstallPath InstallPath InstallPath

Gets the physical path of a directory containing the service application.

(Inherited from ConversionServiceApplication)
IsBackwardsCompatible IsBackwardsCompatible IsBackwardsCompatible Inherited from SPPersistedUpgradableObject
ISharedServiceApplication.DefaultEndpoint ISharedServiceApplication.DefaultEndpoint ISharedServiceApplication.DefaultEndpoint Inherited from SPIisWebServiceApplication
JobExpirationDays JobExpirationDays JobExpirationDays

Number of days for which completed jobs remain in the database before being expired. A value of 0 indicates that jobs do not expire.

KeepAliveTimeout KeepAliveTimeout KeepAliveTimeout

Gets or sets a value that specifies how long a conversion can be non-responsive before it is terminated.

ManageLink ManageLink ManageLink

Gets the uniform resource locator (URL) for the administrative Web site that you use to manage the service application.

MaximumConversionAttempts MaximumConversionAttempts MaximumConversionAttempts

Gets or sets a value that specifies the maximum number of times Word Automation Services will attempt to complete a conversion before marking the conversion job as "Failed".

MaximumConversionTime MaximumConversionTime MaximumConversionTime

Gets or sets a value that indicates the length of time that a conversion can execute before it is terminated.

MaximumMemoryUsage MaximumMemoryUsage MaximumMemoryUsage

Gets or sets a value that specifies the maximum percentage of system memory which can be used by the application manager.

MaximumSyncConversionRequests MaximumSyncConversionRequests MaximumSyncConversionRequests

Maximum sync conversion requests that can be processed at any time

Name Name Name Inherited from SPPersistedObject
NeedsUpgrade NeedsUpgrade NeedsUpgrade Inherited from SPPersistedUpgradableObject
NeedsUpgradeIncludeChildren NeedsUpgradeIncludeChildren NeedsUpgradeIncludeChildren Inherited from SPPersistedUpgradableObject
Parent Parent Parent Inherited from SPPersistedObject
PermissionsLink PermissionsLink PermissionsLink Inherited from SPIisWebServiceApplication
Properties Properties Properties Inherited from SPPersistedObject
PropertiesLink PropertiesLink PropertiesLink

Gets the uniform resource locator (URL) for the Web site that you use to modify the properties for the service application.

RecycleProcessThreshold RecycleProcessThreshold RecycleProcessThreshold

Gets or sets a value that specifies the number of documents which are converted before a single instance of the Word Automation Services code process is recycled.

Service Service Service Inherited from SPServiceApplication
ServiceApplicationProxyGroup ServiceApplicationProxyGroup ServiceApplicationProxyGroup Inherited from SPServiceApplication
ServiceInstances ServiceInstances ServiceInstances Inherited from SPServiceApplication
Shared Shared Shared

Gets a value that specifies whether the service application is shared across multiple SharePoint farms.

Status Status Status Inherited from SPPersistedObject
TermsOfServiceUri TermsOfServiceUri TermsOfServiceUri Inherited from SPIisWebServiceApplication
TimerJobFrequency TimerJobFrequency TimerJobFrequency

Gets a value that specifies the frequency with which the timer job for this service application runs.

TotalActiveProcesses TotalActiveProcesses TotalActiveProcesses

Gets or sets a value that specifies the number of instances of Word Automation Services which are running on a single machine

TypeName TypeName TypeName

Gets a value that specifies the type name for the object.

UpgradeContext UpgradeContext UpgradeContext Inherited from SPPersistedUpgradableObject
UpgradedPersistedProperties UpgradedPersistedProperties UpgradedPersistedProperties Inherited from SPAutoSerializingObject
Uri Uri Uri Inherited from SPIisWebServiceApplication
UseFontEmbeddingSettingsForFixedFormats UseFontEmbeddingSettingsForFixedFormats UseFontEmbeddingSettingsForFixedFormats

Use Font Embedding conversion job settings for fixed formats (QFE 31476)

Version Version Version Inherited from SPPersistedObject
VirtualPath VirtualPath VirtualPath

Gets the virtual path of the WCFservice relative to the service application.

(Inherited from ConversionServiceApplication)
WasCreated WasCreated WasCreated Inherited from SPPersistedObject
WordServiceFormats WordServiceFormats WordServiceFormats

Gets or sets a value that specifies the file formats which are supported by Word Automation Services.

Methods

AddServiceEndpoint(String, SPIisWebServiceBindingType) AddServiceEndpoint(String, SPIisWebServiceBindingType) AddServiceEndpoint(String, SPIisWebServiceBindingType) Inherited from SPIisWebServiceApplication
AddServiceEndpoint(String, SPIisWebServiceBindingType, String) AddServiceEndpoint(String, SPIisWebServiceBindingType, String) AddServiceEndpoint(String, SPIisWebServiceBindingType, String) Inherited from SPIisWebServiceApplication
BeginProvision(AsyncCallback, Object) BeginProvision(AsyncCallback, Object) BeginProvision(AsyncCallback, Object) Inherited from SPServiceApplication
BeginUnprovision(AsyncCallback, Object) BeginUnprovision(AsyncCallback, Object) BeginUnprovision(AsyncCallback, Object) Inherited from SPServiceApplication
CheckAccess(SPIisWebServiceApplicationRights) CheckAccess(SPIisWebServiceApplicationRights) CheckAccess(SPIisWebServiceApplicationRights) Inherited from SPIisWebServiceApplication
CheckAdministrationAccess(SPCentralAdministrationRights) CheckAdministrationAccess(SPCentralAdministrationRights) CheckAdministrationAccess(SPCentralAdministrationRights) Inherited from SPServiceApplication
Clone() Clone() Clone() Inherited from SPPersistedObject
Delete() Delete() Delete()

Deletes the service application.

DemandAccess(SPIisWebServiceApplicationRights) DemandAccess(SPIisWebServiceApplicationRights) DemandAccess(SPIisWebServiceApplicationRights) Inherited from SPIisWebServiceApplication
DemandAdministrationAccess(SPCentralAdministrationRights) DemandAdministrationAccess(SPCentralAdministrationRights) DemandAdministrationAccess(SPCentralAdministrationRights) Inherited from SPServiceApplication
EndProvision(IAsyncResult) EndProvision(IAsyncResult) EndProvision(IAsyncResult) Inherited from SPServiceApplication
EndUnprovision(IAsyncResult) EndUnprovision(IAsyncResult) EndUnprovision(IAsyncResult) Inherited from SPServiceApplication
Equals(Object) Equals(Object) Equals(Object) Inherited from SPPersistedObject
GetAccessControl() GetAccessControl() GetAccessControl() Inherited from SPIisWebServiceApplication
GetAdministrationAccessControl() GetAdministrationAccessControl() GetAdministrationAccessControl() Inherited from SPServiceApplication
GetChild<T>() GetChild<T>() GetChild<T>() Inherited from SPPersistedObject
GetChild<T>(String) GetChild<T>(String) GetChild<T>(String) Inherited from SPPersistedObject
GetDependentProcessIdentities() GetDependentProcessIdentities() GetDependentProcessIdentities() Inherited from SPServiceApplication
GetHashCode() GetHashCode() GetHashCode() Inherited from SPPersistedObject
GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) Inherited from SPAutoSerializingObject
HasAdditionalUpdateAccess() HasAdditionalUpdateAccess() HasAdditionalUpdateAccess() Inherited from SPServiceApplication
Invalidate() Invalidate() Invalidate() Inherited from SPPersistedUpgradableObject
IsConnected(SPServiceApplicationProxy) IsConnected(SPServiceApplicationProxy) IsConnected(SPServiceApplicationProxy) Inherited from SPIisWebServiceApplication
MigrateGroupAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) MigrateGroupAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) MigrateGroupAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) Inherited from SPServiceApplication
MigrateUserAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) MigrateUserAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) MigrateUserAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) Inherited from SPIisWebServiceApplication
OnDependentProcessIdentityChanged() OnDependentProcessIdentityChanged() OnDependentProcessIdentityChanged()

Specifies when there is a change to a process identity that is depended on (like farm service account).

(Inherited from ConversionServiceApplication)
OnDeserialization() OnDeserialization() OnDeserialization() Inherited from SPIisWebServiceApplication
OnProcessIdentityChanged(SecurityIdentifier) OnProcessIdentityChanged(SecurityIdentifier) OnProcessIdentityChanged(SecurityIdentifier)

Grants administrator access to the identity specified by processSecurityIdentifier when there is a change in an application pool or in an application pool's identity.

(Inherited from ConversionServiceApplication)
OpenInstanceConfiguration() OpenInstanceConfiguration() OpenInstanceConfiguration() Inherited from SPIisWebServiceApplication
Provision() Provision() Provision()

Provisions the service application.

ProvisionInstances() ProvisionInstances() ProvisionInstances() Inherited from SPServiceApplication
ProvisionLocal(SPServiceInstance) ProvisionLocal(SPServiceInstance) ProvisionLocal(SPServiceInstance) Inherited from SPIisWebServiceApplication
SetAccessControl(SPIisWebServiceApplicationSecurity) SetAccessControl(SPIisWebServiceApplicationSecurity) SetAccessControl(SPIisWebServiceApplicationSecurity) Inherited from SPIisWebServiceApplication
SetAdministrationAccessControl(SPCentralAdministrationSecurity) SetAdministrationAccessControl(SPCentralAdministrationSecurity) SetAdministrationAccessControl(SPCentralAdministrationSecurity) Inherited from SPServiceApplication
ToString() ToString() ToString() Inherited from SPPersistedObject
ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider)

Formats the value of the current instance of the service application by using the specified format.

(Inherited from ConversionServiceApplication)
Uncache() Uncache() Uncache() Inherited from SPPersistedObject
Unprovision() Unprovision() Unprovision() Inherited from SPServiceApplication
Unprovision(Boolean) Unprovision(Boolean) Unprovision(Boolean)

Unprovisions the service application.

UnprovisionInstances() UnprovisionInstances() UnprovisionInstances() Inherited from SPServiceApplication
UnprovisionLocal(SPServiceInstance) UnprovisionLocal(SPServiceInstance) UnprovisionLocal(SPServiceInstance) Inherited from SPIisWebServiceApplication
Update() Update() Update() Inherited from SPIisWebServiceApplication
Update(Boolean) Update(Boolean) Update(Boolean) Inherited from SPPersistedObject
UpdateParent() UpdateParent() UpdateParent() Inherited from SPAutoSerializingObject
Upgrade() Upgrade() Upgrade() Inherited from SPPersistedUpgradableObject
Upgrade(Boolean) Upgrade(Boolean) Upgrade(Boolean) Inherited from SPPersistedUpgradableObject
Validate() Validate() Validate() Inherited from SPPersistedObject
ValidateBackwardsCompatibility() ValidateBackwardsCompatibility() ValidateBackwardsCompatibility() Inherited from SPPersistedUpgradableObject

Explicit Interface Implementations

IBackupRestore.AddBackupObjects(SPBackupRestoreObject) IBackupRestore.AddBackupObjects(SPBackupRestoreObject) IBackupRestore.AddBackupObjects(SPBackupRestoreObject) Inherited from SPIisWebServiceApplication
IBackupRestore.OnAbort(Object, SPBackupRestoreInformation) IBackupRestore.OnAbort(Object, SPBackupRestoreInformation) IBackupRestore.OnAbort(Object, SPBackupRestoreInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnBackup(Object, SPBackupInformation) IBackupRestore.OnBackup(Object, SPBackupInformation) IBackupRestore.OnBackup(Object, SPBackupInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnBackupComplete(Object, SPBackupInformation) IBackupRestore.OnBackupComplete(Object, SPBackupInformation) IBackupRestore.OnBackupComplete(Object, SPBackupInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnPostRestore(Object, SPRestoreInformation) IBackupRestore.OnPostRestore(Object, SPRestoreInformation) IBackupRestore.OnPostRestore(Object, SPRestoreInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnPrepareBackup(Object, SPBackupInformation) IBackupRestore.OnPrepareBackup(Object, SPBackupInformation) IBackupRestore.OnPrepareBackup(Object, SPBackupInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnPreRestore(Object, SPRestoreInformation) IBackupRestore.OnPreRestore(Object, SPRestoreInformation) IBackupRestore.OnPreRestore(Object, SPRestoreInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnRestore(Object, SPRestoreInformation) IBackupRestore.OnRestore(Object, SPRestoreInformation) IBackupRestore.OnRestore(Object, SPRestoreInformation) Inherited from SPIisWebServiceApplication

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)

Applies to