FormsService FormsService FormsService FormsService Class

Definition

Represents the top level entity of InfoPath Forms Services.

public ref class FormsService sealed : Microsoft::SharePoint::Administration::SPService, Microsoft::SharePoint::Administration::Backup::IBackupRestoreConfiguration
[System.Runtime.InteropServices.Guid("543DD7B9-6E48-438d-86D8-000000000000")]
public sealed class FormsService : Microsoft.SharePoint.Administration.SPService, Microsoft.SharePoint.Administration.Backup.IBackupRestoreConfiguration
type FormsService = class
    inherit SPService
    interface IBackupRestoreConfiguration
    interface IBackupRestore
Public NotInheritable Class FormsService
Inherits SPService
Implements IBackupRestoreConfiguration
Inheritance
Attributes
Implements

Examples

The following code example writes the forms service status to the console that the forms service is not available. References are required in the Visual Studio project to the Microsoft.Office.Server, the Microsoft.Office.InfoPath.Server, and the Microsoft.SharePoint assemblies.

Note: Browse for the Microsoft.Office.InfoPath.Server assembly at [drive]:\Program Files\Microsoft Office Servers\14.0\Bin.

For the example to work, Import statements are required for the

Microsoft.Office.Server, the Microsoft.Office.InfoPath.Server.Administration, and the Microsoft.SharePoint.Administration namespaces.

    Dim LocalFormsService As <span class="label">FormsService</span>
Try
    LocalFormsService = SPFarm.Local.Services.GetValue(Of FormsService)(<span class="label">FormsService</span>.ServiceName)
    Console.WriteLine(LocalFormsService.Status.ToString())
Catch ex As Exception
    Console.WriteLine("The forms service is not provisioned.")
End Try

For the example to work, using statements are required for the

Microsoft.Office.Server, the Microsoft.Office.InfoPath.Server.Administration, and the Microsoft.SharePoint.Administration namespaces.

<span class="label">FormsService</span> localFormsService;
try
{
    localFormsService = SPFarm.Local.Services.GetValue&lt;FormsService&gt;(<span class="label">FormsService</span>.ServiceName);
    Console.WriteLine(localFormsService.Status.ToString());
}
Catch (Exception ex)
{
    Console.WriteLine("The forms service is not provisioned.");
}

Remarks

The FormsService object is an SharePoint Server 2010 shared service provider that extends the SPService object. Like all shared service providers, it is load-balanced and runs at the farm level. There is only one instance of the forms service per farm.

Constructors

FormsService() FormsService() FormsService() FormsService()

Initializes a new instance of the FormsService class.

FormsService(String, SPFarm) FormsService(String, SPFarm) FormsService(String, SPFarm) FormsService(String, SPFarm)

Initializes a new instance of the FormsService class using the specified service name and farm.

Fields

ServiceId ServiceId ServiceId ServiceId

The forms service identification.

ServiceName ServiceName ServiceName ServiceName

The forms service name.

Properties

ActiveSessionsTimeout ActiveSessionsTimeout ActiveSessionsTimeout ActiveSessionsTimeout

Gets or sets the duration, in minutes, that a form session state can remain active.

AllowEmbeddedSqlForDataConnections AllowEmbeddedSqlForDataConnections AllowEmbeddedSqlForDataConnections AllowEmbeddedSqlForDataConnections

Gets or sets a value that indicates whether embedded SQL authentication can be used by browser-enabled form templates.

AllowUdcAuthenticationForDataConnections AllowUdcAuthenticationForDataConnections AllowUdcAuthenticationForDataConnections AllowUdcAuthenticationForDataConnections

Gets or sets the value that indicates whether authentication information in a Universal Data Connection (UDC) file can be used.

AllowUserFormBrowserEnabling AllowUserFormBrowserEnabling AllowUserFormBrowserEnabling AllowUserFormBrowserEnabling

Gets or sets the value that indicates whether users can browser-enable form templates that do not contain form code, require full trust, enable rendering on a mobile device, or use a data connection managed by a server administrator.

AllowUserFormBrowserRendering AllowUserFormBrowserRendering AllowUserFormBrowserRendering AllowUserFormBrowserRendering

Gets or sets the value that indicates whether browser-enabled form templates will be rendered by InfoPath Forms Services.

AllowUserFormCrossDomainDataConnections AllowUserFormCrossDomainDataConnections AllowUserFormCrossDomainDataConnections AllowUserFormCrossDomainDataConnections

Gets or sets the value that indicates whether data connections to data sources located in a different domain can be queried.

AllowViewState AllowViewState AllowViewState AllowViewState

This member is reserved for internal use and is not intended to be used directly from your code.

Applications Applications Applications Applications Inherited from SPService
CanUpgrade CanUpgrade CanUpgrade CanUpgrade Inherited from SPPersistedUpgradableObject
DataConnectionFiles DataConnectionFiles DataConnectionFiles DataConnectionFiles

Gets the collection of Universal Data Connection (UDC) files available on the server farm.

DefaultDataConnectionTimeout DefaultDataConnectionTimeout DefaultDataConnectionTimeout DefaultDataConnectionTimeout

Gets or sets the default data connection timeout in milliseconds.

DisplayName DisplayName DisplayName DisplayName Inherited from SPPersistedObject
ExemptUserAgents ExemptUserAgents ExemptUserAgents ExemptUserAgents

Gets a collection of ExemptUserAgent objects

Farm Farm Farm Farm Inherited from SPPersistedObject
FormTemplates FormTemplates FormTemplates FormTemplates

Gets a collection of all administrator approved, browser-enabled form templates deployed to the server farm.

Id Id Id Id Inherited from SPPersistedObject
Instances Instances Instances Instances Inherited from SPService
IsBackwardsCompatible IsBackwardsCompatible IsBackwardsCompatible IsBackwardsCompatible Inherited from SPPersistedUpgradableObject
JobDefinitions JobDefinitions JobDefinitions JobDefinitions Inherited from SPService
JobHistoryEntries JobHistoryEntries JobHistoryEntries JobHistoryEntries Inherited from SPService
MaxDataConnectionResponseSize MaxDataConnectionResponseSize MaxDataConnectionResponseSize MaxDataConnectionResponseSize

Gets or sets the maximum size allowed for a data connection response.

MaxDataConnectionRoundTrip MaxDataConnectionRoundTrip MaxDataConnectionRoundTrip MaxDataConnectionRoundTrip

Gets or sets the maximum amount of time allowed for a data connection to retrieve data.

MaxDataConnectionTimeout MaxDataConnectionTimeout MaxDataConnectionTimeout MaxDataConnectionTimeout

Gets or sets the maximum data connection timeout in milliseconds.

MaxFormLoadTime MaxFormLoadTime MaxFormLoadTime MaxFormLoadTime

Gets or sets the maximum amount of time allowed for a form to load on the server.

MaxPostbacksPerSession MaxPostbacksPerSession MaxPostbacksPerSession MaxPostbacksPerSession

Gets or sets the value of the maximum postbacks an instance of a browser-enabled form template can make to the forms service.

MaxSizeOfFormSessionState MaxSizeOfFormSessionState MaxSizeOfFormSessionState MaxSizeOfFormSessionState

Gets or sets the value of the maximum size of session state an instance of a browser-enabled form template can use.

MaxSizeOfUserFormState MaxSizeOfUserFormState MaxSizeOfUserFormState MaxSizeOfUserFormState

Gets or sets the value of the maximum size of user session data that an instance of a browser-enabled form template can use.

MaxUserActionsPerPostback MaxUserActionsPerPostback MaxUserActionsPerPostback MaxUserActionsPerPostback

Gets or sets the maximum user actions per postback.

MemoryCacheSize MemoryCacheSize MemoryCacheSize MemoryCacheSize

Gets or sets the size of the memory cache used for the components of browser-enabled form templates.

Name Name Name Name Inherited from SPPersistedObject
NeedsUpgrade NeedsUpgrade NeedsUpgrade NeedsUpgrade Inherited from SPPersistedUpgradableObject
NeedsUpgradeIncludeChildren NeedsUpgradeIncludeChildren NeedsUpgradeIncludeChildren NeedsUpgradeIncludeChildren Inherited from SPPersistedUpgradableObject
Parent Parent Parent Parent Inherited from SPPersistedObject
Properties Properties Properties Properties Inherited from SPPersistedObject
Required Required Required Required Inherited from SPService
RequireSslForDataConnections RequireSslForDataConnections RequireSslForDataConnections RequireSslForDataConnections

Gets or sets the Secure Sockets Layer (SSL) requirement value.

RunningJobs RunningJobs RunningJobs RunningJobs Inherited from SPService
Status Status Status Status Inherited from SPPersistedObject
TypeName TypeName TypeName TypeName

Gets the display name for the parent type FormsService.

UpgradeContext UpgradeContext UpgradeContext UpgradeContext Inherited from SPPersistedUpgradableObject
UpgradedPersistedProperties UpgradedPersistedProperties UpgradedPersistedProperties UpgradedPersistedProperties Inherited from SPAutoSerializingObject
Version Version Version Version Inherited from SPPersistedObject
ViewStateThreshold ViewStateThreshold ViewStateThreshold ViewStateThreshold

Gets or sets the maximum size, in kilobytes, of the session state when stored in the form view.

WasCreated WasCreated WasCreated WasCreated Inherited from SPPersistedObject

Methods

AllowUserFormWebServiceProxy(Uri, Boolean) AllowUserFormWebServiceProxy(Uri, Boolean) AllowUserFormWebServiceProxy(Uri, Boolean) AllowUserFormWebServiceProxy(Uri, Boolean)

Controls whether a form opened in the InfoPath client can use the InfoPath Forms Services Web service proxy to connect to a Web service.

AllowWebServiceProxy(Uri, Boolean) AllowWebServiceProxy(Uri, Boolean) AllowWebServiceProxy(Uri, Boolean) AllowWebServiceProxy(Uri, Boolean)

Controls whether browser-enabled form templates can use the InfoPath Forms Services Web service proxy to connect to a Web service.

BrowserEnableUserFormTemplate(SPFile) BrowserEnableUserFormTemplate(SPFile) BrowserEnableUserFormTemplate(SPFile) BrowserEnableUserFormTemplate(SPFile)

Browser-enables a browser-compatible form template that does not contain form code, require full trust, enable rendering on a mobile device, or use a data connection managed by a server administrator.

Clone() Clone() Clone() Clone() Inherited from SPPersistedObject
Delete() Delete() Delete() Delete() Inherited from SPService
Equals(Object) Equals(Object) Equals(Object) Equals(Object) Inherited from SPPersistedObject
GetCertificate(Boolean) GetCertificate(Boolean) GetCertificate(Boolean) GetCertificate(Boolean)

This member is reserved for internal use and is not intended to be used directly from your code.

GetChild<T>() GetChild<T>() GetChild<T>() GetChild<T>() Inherited from SPPersistedObject
GetChild<T>(String) GetChild<T>(String) GetChild<T>(String) GetChild<T>(String) Inherited from SPPersistedObject
GetCreateApplicationLink(Type) GetCreateApplicationLink(Type) GetCreateApplicationLink(Type) GetCreateApplicationLink(Type) Inherited from SPService
GetCreateApplicationOptions(Type) GetCreateApplicationOptions(Type) GetCreateApplicationOptions(Type) GetCreateApplicationOptions(Type) Inherited from SPService
GetDisabledCertificateById(String) GetDisabledCertificateById(String) GetDisabledCertificateById(String) GetDisabledCertificateById(String)

This member is reserved for internal use and is not intended to be used directly from your code.

GetHashCode() GetHashCode() GetHashCode() GetHashCode() Inherited from SPPersistedObject
GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) Inherited from SPAutoSerializingObject
HasAdditionalUpdateAccess() HasAdditionalUpdateAccess() HasAdditionalUpdateAccess() HasAdditionalUpdateAccess() Inherited from SPPersistedObject
Invalidate() Invalidate() Invalidate() Invalidate() Inherited from SPPersistedUpgradableObject
IsUserFormTemplateBrowserEnabled(SPFile) IsUserFormTemplateBrowserEnabled(SPFile) IsUserFormTemplateBrowserEnabled(SPFile) IsUserFormTemplateBrowserEnabled(SPFile)

Returns a boolean value that indicates if a form template is browser-enabled.

IsUserLicensedForEntity(String) IsUserLicensedForEntity(String) IsUserLicensedForEntity(String) IsUserLicensedForEntity(String) Inherited from SPService
OnDeserialization() OnDeserialization() OnDeserialization() OnDeserialization() Inherited from SPPersistedObject
Provision() Provision() Provision() Provision()

Provisions the forms service on the SharePoint server farm.

SetCertificateDisabled(String, Boolean) SetCertificateDisabled(String, Boolean) SetCertificateDisabled(String, Boolean) SetCertificateDisabled(String, Boolean)

This member is reserved for internal use and is not intended to be used directly from your code.

ToString() ToString() ToString() ToString() Inherited from SPPersistedObject
Uncache() Uncache() Uncache() Uncache() Inherited from SPPersistedObject
Unprovision() Unprovision() Unprovision() Unprovision()

Removes the forms service from the SharePoint server farm.

Update() Update() Update() Update()

An override of the Update() method of the SPPersistedObject object.

Update(Boolean) Update(Boolean) Update(Boolean) Update(Boolean) Inherited from SPPersistedObject
UpdateParent() UpdateParent() UpdateParent() UpdateParent() Inherited from SPAutoSerializingObject
Upgrade() Upgrade() Upgrade() Upgrade() Inherited from SPPersistedUpgradableObject
Upgrade(Boolean) Upgrade(Boolean) Upgrade(Boolean) Upgrade(Boolean) Inherited from SPPersistedUpgradableObject
Validate() Validate() Validate() Validate() Inherited from SPPersistedObject
ValidateBackwardsCompatibility() ValidateBackwardsCompatibility() ValidateBackwardsCompatibility() ValidateBackwardsCompatibility() Inherited from SPPersistedUpgradableObject

Explicit Interface Implementations

IBackupRestore.AddBackupObjects(SPBackupRestoreObject) IBackupRestore.AddBackupObjects(SPBackupRestoreObject) IBackupRestore.AddBackupObjects(SPBackupRestoreObject) IBackupRestore.AddBackupObjects(SPBackupRestoreObject)

Reserved for internal use. Adds the IBackupRestore object and its child IBackupRestore objects to the specified backup object.

IBackupRestore.CanRenameOnRestore IBackupRestore.CanRenameOnRestore IBackupRestore.CanRenameOnRestore IBackupRestore.CanRenameOnRestore

Reserved for internal use. Gets a value that indicates whether the IBackupRestore object can be renamed when it is restored.

IBackupRestore.CanSelectForBackup IBackupRestore.CanSelectForBackup IBackupRestore.CanSelectForBackup IBackupRestore.CanSelectForBackup

Reserved for internal use. Gets or sets a value that indicates whether the content component that is represented by the IBackupRestore object can be selected for backup, independently of its parent component, in the Central Administration user interface or some other UI.

IBackupRestore.CanSelectForRestore IBackupRestore.CanSelectForRestore IBackupRestore.CanSelectForRestore IBackupRestore.CanSelectForRestore

Reserved for internal use. Gets or sets a value that indicates whether the content component that is represented by the IBackupRestore object can be selected for restoration in the Central Administration user interface or some other UI.

IBackupRestore.DiskSizeRequired IBackupRestore.DiskSizeRequired IBackupRestore.DiskSizeRequired IBackupRestore.DiskSizeRequired

Reserved for internal use. Gets the amount of disk space, in bytes, that is required to store a backup of the content represented by the IBackupRestore object.

IBackupRestore.Id IBackupRestore.Id IBackupRestore.Id IBackupRestore.Id

Reserved for internal use. Gets or sets an ID for the content component.

IBackupRestore.Name IBackupRestore.Name IBackupRestore.Name IBackupRestore.Name

Reserved for internal use. Gets or sets a name, for use in a UI, for the content component.

IBackupRestore.OnAbort(Object, SPBackupRestoreInformation) IBackupRestore.OnAbort(Object, SPBackupRestoreInformation) IBackupRestore.OnAbort(Object, SPBackupRestoreInformation) IBackupRestore.OnAbort(Object, SPBackupRestoreInformation)

Reserved for internal use. Assists in a graceful termination when a user cancels a backup or restore operation.

IBackupRestore.OnBackup(Object, SPBackupInformation) IBackupRestore.OnBackup(Object, SPBackupInformation) IBackupRestore.OnBackup(Object, SPBackupInformation) IBackupRestore.OnBackup(Object, SPBackupInformation)

Reserved for internal use. Creates and stores the backup copy of the content component.

IBackupRestore.OnBackupComplete(Object, SPBackupInformation) IBackupRestore.OnBackupComplete(Object, SPBackupInformation) IBackupRestore.OnBackupComplete(Object, SPBackupInformation) IBackupRestore.OnBackupComplete(Object, SPBackupInformation)

Reserved for internal use. Provides post backup processing.

IBackupRestore.OnPostRestore(Object, SPRestoreInformation) IBackupRestore.OnPostRestore(Object, SPRestoreInformation) IBackupRestore.OnPostRestore(Object, SPRestoreInformation) IBackupRestore.OnPostRestore(Object, SPRestoreInformation)

Reserved for internal use. Provides post restore processing.

IBackupRestore.OnPrepareBackup(Object, SPBackupInformation) IBackupRestore.OnPrepareBackup(Object, SPBackupInformation) IBackupRestore.OnPrepareBackup(Object, SPBackupInformation) IBackupRestore.OnPrepareBackup(Object, SPBackupInformation)

Reserved for internal use. Creates and stores the backup copy of the content component.

IBackupRestore.OnPreRestore(Object, SPRestoreInformation) IBackupRestore.OnPreRestore(Object, SPRestoreInformation) IBackupRestore.OnPreRestore(Object, SPRestoreInformation) IBackupRestore.OnPreRestore(Object, SPRestoreInformation)

Reserved for internal use. Provides restore preparation processing.

IBackupRestore.OnRestore(Object, SPRestoreInformation) IBackupRestore.OnRestore(Object, SPRestoreInformation) IBackupRestore.OnRestore(Object, SPRestoreInformation) IBackupRestore.OnRestore(Object, SPRestoreInformation)

Reserved for internal use. Reads the backed up content and copies it to the target destination of the restore operation.

IBackupRestoreConfiguration.CanBackupRestoreAsConfiguration IBackupRestoreConfiguration.CanBackupRestoreAsConfiguration IBackupRestoreConfiguration.CanBackupRestoreAsConfiguration IBackupRestoreConfiguration.CanBackupRestoreAsConfiguration

Reserved for internal use. Gets a value that indicates whether the component can be included in a configuration-only backup or restore.

Extension Methods

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

Applies to