SPWebApplication Members

  • Articolo

Include Protected Members
Include Inherited Members

Represents an Internet Information Services (IIS) load-balanced Web application that is installed on the server farm.

The SPWebApplication type exposes the following members.

Constructors

  Name Description
Public method SPWebApplication() Reserved for internal use.
Public method SPWebApplication(String, SPWebService, SPApplicationPool) Initializes a new instance of the SPWebApplication class.

Top

Properties

  Name Description
Public property AlertFlags Obsolete. Do not use. Has no effect.
Public property AlertsEnabled Gets or sets a value that specifies whether alerts are allowed in the Web application.
Public property AlertsEventBatchSize Obsolete. Do not use. Has no effect.
Public property AlertsLimited Gets or sets a value specifying whether there is a limit to the number of lists and list items for which a user can create alerts.
Public property AlertsMaximum Gets or sets the maximum number of lists and list items for which a single user can create alerts.
Public property AlertsMaximumQuerySet Gets or sets the maximum number of records in a query set that is associated with this alert object.
Public property AllowAccessToWebPartCatalog Gets or sets a value that indicates whether sites in the Web application can use Web Parts from the global catalog.
Public property AllowContributorsToEditScriptableParts Gets or sets a Boolean value that determines whether contributers are allowed to edit scriptable Web Parts.
Public property AllowDesigner Gets or sets a Boolean value that specifies whether SharePoint Designer can be used to edit Web sites within the Web application.
Public property AllowedInlineDownloadedMimeTypes Gets the MIME content-types that are not forced to be saved to the downloading user's local machine. Files withcontent-types that are not listed in this collection are assumed to contain script and therefore can interact with the application on the user'sbehalf.
Public property AllowHighCharacterListFolderNames Gets or sets a Boolean value that determines whether non-alphanumeric characters are allowed in automatically generated list folder names.
Public property AllowMasterPageEditing Gets or sets a Boolean value that specifies whether users are allowed to edit master pages.
Public property AllowOMCodeOverrideThrottleSettings Gets or sets a Boolean value that specifies whether custom object model code can override the throttle settings.
Public property AllowPartToPartCommunication Gets or sets a value indicating whether the Web application allows Web Parts to communicate with each other.
Public property AllowRevertFromTemplate Gets or sets a Boolean value that specifies whether customized sites can be reverted to their base templates.
Public property AllowSilverlightPrompt Gets or sets a value that indicates whether UI elements that use Microsoft Silverlight to render should prompt the user to download the Silverlight application.
Public property AlternateUrls Gets the collection of URLs that are routed to the Web application and specifies which zone they come from.
Public property AlwaysProcessDocuments Gets or sets a Boolean value that determines whether documents are always processed by document parsers before being returned.
Public property ApplicationPool Gets or sets the application pool that is used by the Web application.
Public property ApplicationPrincipalMaxRights Gets or sets the maximum rights that any application principal user will have in the Web application.
Public property AutomaticallyDeleteUnusedSiteCollections Gets or sets a value specifying whether unused site collections can be automatically deleted.
Public property BlockedFileExtensions Gets the list of file extensions that cannot be uploaded or downloaded from sites in the Web application.
Public property BrowserCEIPEnabled Gets or sets a value that indicates whether the Customer Experience Improvement Program (CEIP) option is enabled in the browser.
Public property BrowserFileHandling Gets or sets a value that controls how files are treated in the browser.
Public property CanMigrate Obsolete. Gets a value indicating whether the settings for the Web application can be migrated from the Windows SharePoint Services 2.0 Web application with which it is paired.
Public property CanRenameOnRestore Gets a value specifying whether the application can be renamed when it is restored.
Public property CanSelectForBackup Gets or sets a value specifying whether the Web application can be backed up.
Public property CanSelectForRestore Gets or sets a value specifying whether the Web application can be restored.
Public property CanUpgrade Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property CascadeDeleteMaximumItemLimit Gets or sets the maximum number of items that can be checked in aCascade or Restrict delete operation.
Public property CascadeDeleteTimeoutMultiplier Gets or sets the cost per item deleted in a referential integrity delete operation.
Public property CellStorageDataCleanupExcludedDocTypes Gets or sets document types to exclude from a cell storage data cleanup timer job so that associated file fragments are not deleted.
Public property CellStorageUserDataDeleteIncludedDocTypes Gets or sets document types to include in a cell storage data cleanup timer job so that associated file fragments are deleted.
Public property CellStorageUserDataDeleteSizeThreshold Gets or sets the size threshold for a cell storage user data delete timer job, so that the timer job only deletes file fragments in the file fragments table that surpass the specified size.
Public property CellStorageWebServiceEnabled Gets or sets a Boolean value that specifies whether the WebSvcCellStorage Web service is enabled.
Public property ChangeLogExpirationEnabled Gets or sets a value specifying whether change logs are deleted after the time span defined in the ChangeLogRetentionPeriod property.
Public property ChangeLogRetentionPeriod Gets or sets the number of days to retain change logs.
Public property ClientCallableSettings Gets the settings that control client-callable behaviors for the client object model, or specifically, for the Windows Communication Foundation (WCF) service that is provided through client.svc.
Public property ContentDatabases Gets a collection of content databases that are available to the Web application.
Public property DailyStartUnthrottledPrivilegedOperationsHour Gets the hour of the start time for an unthrottled privilege operation according to the local time zone.
Public property DailyStartUnthrottledPrivilegedOperationsMinute Gets or sets the minute of the start time for an unthrottled privilege operation according to the local time zone.
Public property DailyUnthrottledPrivilegedOperationsDuration Gets or sets the duration in hours for an unthrottled privilege operation.
Public property DataRetrievalProvider Gets settings related to the data retrieval service.
Public property DaysToShowNewIndicator Gets or sets the number of days that the New icon appears next to new list items.
Public property DefaultQuotaTemplate Gets or sets the default quota template used for all site collections.
Public property DefaultServerComment Gets the server comment that is associated with the IIS Web site for use when a comment is not specified by the Web application.
Public property DefaultTimeZone Gets or sets the default time zone for the Web application.
Public property DisableCoauthoring Gets or sets a Boolean value that specifies whether shared file locking is enabled for coauthoring Microsoft Office, an integrated system of programs, servers, and services documents.
Public property DiskSizeRequired Gets the disk space that is required to back up the Web application.
Public property DisplayName Gets the user-friendly name that is used to describe the Web application. (Overrides SPPersistedObject.DisplayName.)
Public property DocumentConversionsEnabled Gets or sets a value that specifies whether to enable document conversion.
Public property DocumentConversionsLoadBalancerServerId Gets or sets the ID of the server in the farm that contains the load balancer.
Public property DocumentConversionsLoadBalancerUrl Gets or sets the URL to the load balancer for document conversions.
Public property DocumentConversionsSchedule Gets or sets the schedule for a document conversion timer job.
Public property DocumentConverters Gets a collection of document converters for the Web application.
Public property EmailToNoPermissionWorkflowParticipantsEnabled Gets or sets a Boolean value that specifies whether to alert users without site permissions when they have been assigned workflow tasks.
Public property EnabledClaimProviders This member is reserved for internal use and is not intended to be used directly from your code.
Public property EventHandlersEnabled Obsolete. Gets or sets a value indicating whether to enable event handlers for the Web application.
Public property EventLogRetentionPeriod Gets or sets the amount of time to preserve event logs.
Public property ExternalUrlZone Gets or sets the URL zone to be used for cross-firewall access. A URL zone is a location in the topology of the server farm.
Public property ExternalWorkflowParticipantsEnabled Gets or sets a Boolean value that specifies whether external users can participate in workflow by sending them a document copy.
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Features Gets the set of Features activated for the Web application.
Public property FileNotFoundPage Gets or sets the name of an HTML file relative to \\Program Files\Common Files\Microsoft Shared\web server extensions\14\LAYOUTS\Locale_ID that contains the error information that is used when a file cannot be found.
Public property FormDigestSettings Gets a collection of security validation settings.
Public property HttpThrottleSettings Gets an object that provides management and configuration settings for performance monitoring and HTTP request throttling.
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property IisSettings Gets a collection of settings for all Internet Information Services (IIS) instances that belong to the Web application.
Public property IncomingEmailServerAddress Gets or sets the server name at which incoming e-mail is received.
Public property InheritDataRetrievalSettings Gets or sets a value indicating whether the Web application inherits data retrieval services settings from the central administration application.
Public property IsAdministrationWebApplication Gets or sets a Boolean value specifying whether the Web application is the Central Administration application.
Public property IsBackwardsCompatible Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
Public property IsPaired Obsolete. Gets or sets a value indicating whether the Web application is paired to a Windows SharePoint Services 2.0 Web application.
Public property JobDefinitions Gets the collection of job definitions for the Web application.
Public property JobHistoryEntries Gets an enumeration of the job history entries for the Web application.
Protected property LocalPaths Gets the paths on the local machine to files that are served by the Web application.
Public property MasterPageReferenceEnabled Gets or sets a Boolean value that specifies whether site administrators can turn on or off dynamic master page referencing for application pages.
Public property MaxDiscussionBoardItemsForSiteDataFolderQuery Obsolete.
Public property MaximumFileSize Gets or sets the size of the largest file that can be uploaded.
Public property MaxItemsPerThrottledOperation Gets or sets a number representing the count of items at which list operations begin to be throttled.
Public property MaxItemsPerThrottledOperationOverride Gets or sets the maximum items that are not throttled per operation when the current user is an administrator or auditor by security proxy.
Public property MaxItemsPerThrottledOperationWarningLevel Gets or sets the warning level settings for the number of list items in list operations.
Public property MaxListItemRowStorage Gets or sets the maximum row ordinal that a list item may have.
Public property MaxQueryLookupFields Gets or sets the maximum number of lookup fields that may be included in a list item query.
Public property MaxSizePerCellStorageOperation Gets or sets the maximum size, in bytes, of items that can be allowed in a single cell storage operation.
Public property MaxUniquePermScopesPerList Gets or sets the maximum unique scopes that a list can have.
Public property MetaWeblogAuthenticationEnabled Gets or sets a Boolean value that specifies whether to accept the user name and password from the MetaWeblog API.
Public property MetaWeblogEnabled Gets or sets a Boolean value that specifies whether to enable the MetaWeblog API for the Web application.
Public property MimeMappings Gets a collection of Multipurpose Internet Mail Extension (MIME) mapping overrides for files based onthe file extension and programmatic identifier (ProgId) of the files.
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 property NeedsUpgrade Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property NeedsUpgradeIncludeChildren Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
Public property OfficialFileHosts Gets a collection of SPOfficialFileHost objects.
Public property OfficialFileName Gets or sets the name of the Records Repository Web Service to use to get the official file.
Public property OfficialFileUrl Gets or sets the URL of the Records Repository Web Service to use to get the official file.
Public property OutboundMailCodePage Gets or sets the default code page to use when sending e-mail.
Public property OutboundMailReplyToAddress Gets or sets the default reply-to e-mail address to use when sending e-mail.
Public property OutboundMailSenderAddress Gets or sets the default sender (from) address to use when sending e-mail messages.
Public property OutboundMailServiceInstance Gets or sets the SMTP e-mail service used for sending e-mail.
Public property OutboundSmsServiceAccount Gets the account with a mobile messaging service provider that is used by the Web application to sent mobile alerts.
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property PeoplePickerSettings Gets an object that represents the people picker settings used in the control for selecting users and groups within the Web application.
Public property Policies Gets the collection of security policies that are defined for the Web application, overriding any policies set for a zone.
Public property PolicyRoles Gets the collection of policy roles that are defined for the Web application.
Public property Prefixes Gets the set of paths at which sites may be created.
Public property PresenceEnabled Gets or sets a value that determines whether presence information will be exposed in the Web application.
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property PublicFolderRootUrl Obsolete. Gets or sets the root of the public folder to which the Web application listens for document library e-mail inserts.
Public property RecycleBinCleanupEnabled Gets or sets a value that determines whether recycle bin cleanup is enabled.
Public property RecycleBinEnabled Gets or sets a value that determines whether the recycle bin is enabled.
Public property RecycleBinRetentionPeriod Gets or sets the number of days items are kept in the recycle bin.
Public property RenderingFromMetainfoEnabled Gets or sets a Boolean value that specifies whether to enable page roundtrip optimization.
Public property RequireContactForSelfServiceSiteCreation Gets or sets a value indicating whether self-service site creation requires the site owner's contact information.
Public property RichTextEditorShortcutEnabled
Public property RightsMask Gets or sets the rights mask of the Web application.
Public property RunningJobs Gets the collection of running jobs for the Web application.
Public property ScopeExternalConnectionsToSiteSubscriptions
Public property SecondStageRecycleBinQuota Gets or sets a value that contains the percentage of storage quota that is allocated to second stage recycle bin.
Public property SelfServiceSiteCreationEnabled Gets or sets a value indicating whether self-service site creation is available in the application.
Public property SendLoginCredentialsByEmail Gets or sets a value indicating whether a new user's login credentials are sent to them by e-mail when their account is created.
Public property SendUnusedSiteCollectionNotifications Gets or sets a value that indicates whether a notification is sent to owners of unused sites.
Public property ServiceApplicationProxyGroup Gets or sets the group of references for service application proxies.
Public property ShowURLStructure Gets or sets a Boolean value that specifies whether users are allowed to see the file structures of Web sites.
Public property SiteDataServers Gets a dictionary that maps URL zones to a list of server URIs that are available to access content through the WebSvcSiteData Web service.
Public property Sites Gets the collection of all site collections in the Web application.
Public property SiteSubscriptions Gets the collection of site subscriptions in the Web application.
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property StorageMetricsProcessingDuration Gets or sets the maximum duration, in seconds, to allow the processing of metric changes for documents.
Public property SyndicationEnabled Gets or sets a value specifying whether to enable syndication.
Public property TypeName Gets a string that indicates the type of object of the Web application. (Overrides SPPersistedObject.TypeName.)
Public property UnthrottledPrivilegedOperationWindowEnabled Gets or sets a Boolean value that specifies whether to enable the unthrottled daily time window. If enabled,large list operations will not be throttled when they occur within the time window.
Public property UnusedSiteNotificationPeriod Gets or sets the amount of time that a site is unused before sending a notification.
Public property UnusedSiteNotificationsBeforeDeletion Gets or sets the number of notifications that are sent before an unused site is deleted.
Public property UpgradeContext Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property UseClaimsAuthentication Gets or sets a Boolean value that indicates whether claims authentication is enabled.
Public property UserDefinedWorkflowMaximumComplexity
Public property UserDefinedWorkflowsEnabled Gets or sets a Boolean value specifying whether users can create workflows in the Web application.
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.)
Public property WebConfigModifications Gets a collection of web.config modifications that are applied across all servers for the Web application. If the front end of the Web application is not located on the SQL server with the back end, the web.config modifications are applied only to the front end of the Web application.
Public property WebFileExtensions Gets the file extensions to identify Web files.
Public property WebService Gets the parent Web service of the Web application.

Top

Methods

  Name Description
Public method AddBackupObjects Adds the Web application and its children to the backup/restore job.
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 CurrentUserIgnoreThrottle Detects whether throttling can be ignored for the current Web application. Throttling can be ignored if the current user has administrator-level privileges for computer or if throttling is not set to occur in the current window of time.
Public method Delete Removes the Web application and some of the resources that it owns. (Overrides SPPersistedObject.Delete().)
Public method EnsureDefaultJobs Ensures that the default timer job definitions exist for the Web application.
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 GetDeletedSites() Gets a list of deleted sites using a default query.
Public method GetDeletedSites(Guid) Gets a list of deleted sites with the specified site collection identifier (ID).
Public method GetDeletedSites(String) Gets a list of deleted sites with the specified prefix of a server-relative URL.
Public method GetDeletedSites(SPDeletedSiteQuery) Gets a list of deleted sites using the specified query.
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetIisSettingsWithFallback Returns the set of Internet Information Services (IIS) settings for the specified zone.
Public method GetMappedPage(String) Returns the location of the customized application page.
Public method GetMappedPage(SPWebApplication.SPCustomPage) Returns the location of the customized application page.
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Protected methodStatic member GetRequestPath Obsolete. This member is reserved for internal use and is not intended to be used directly from your code.
Public method GetResponseUri(SPUrlZone) Returns the absolute root of the URI for the given zone.
Public method GetResponseUri(SPUrlZone, String) Retrieves the absolute root of the URI for the given zone and appends the specified path to the end.
Public method GetSecurityTokenServiceEndPointAddress Returns the endpoint URI of the security token service based on the specified request zone.
Public method GetType (Inherited from Object.)
Public method GrantAccessToProcessIdentity(String) Grants the specified process identity account access to the Web application based on the username. Access to the process identity provides the permissions that are specified in the policy role parameter.
Public method GrantAccessToProcessIdentity(String, SPPolicyRoleType) Grants the specified process identity account access to the Web application based on the name of the user and the level of access. Access to the process identity provides full control of the SharePoint Web application.
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Protected method InstallClaimsAuthFiles This member is reserved for internal use and is not intended to be used directly from your code.
Protected method InstallFiles Installs the Microsoft ASP .NET configuration and resource files that are required to provision the application.
Public method Invalidate Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
Public method IsUnthrottledPrivilegedOperationsAllowed Returns a Boolean value that indicates whether the current time is included in the unthrottled service window.
Public methodStatic member Lookup Finds the Web application that is located at the specified URL.
Protected method MemberwiseClone (Inherited from Object.)
Public method Migrate() Obsolete. Migrates the settings from a Windows SharePoint Services 2.0 Web application with which the Web application is paired.
Public method Migrate(Boolean) Obsolete. Migrates the settings from a Windows SharePoint Services 2.0 Web application with which the Web application is paired, with the option of including all children.
Public method MigrateUsers(Boolean) Converts existing users to or from accounts that use claims authentication.
Public method MigrateUsers(IMigrateUserCallback) Converts user accounts to or from an account that uses claims authentication.
Public method OnAbort Raises the Abort (backup) event.
Public method OnBackup Raises the Backup event.
Public method OnBackupComplete Raises the BackupComplete event.
Protected method OnDeserialization Called after the object has been deserialized from the file system cache or the database. (Overrides SPPersistedObject.OnDeserialization().)
Public method OnPostRestore Raises the PostRestore event.
Public method OnPrepareBackup Raises the PreBackup event.
Public method OnPreRestore Raises the PreRestore event.
Public method OnRestore Raises the Restore event.
Public method Provision Provisions the application on the local server, including content databases if necessary. (Overrides SPPersistedObject.Provision().)
Public method ProvisionGlobally Provisions the Web application to all servers that are running the current object's parent Web service.
Public method QueryFeatures(Guid) Retrieves all features in the current Web application that are scoped to Site or Web and have the specified feature identifier.
Public method QueryFeatures(SPFeatureScope, Boolean) Retrieves all features in the current Web application that are scoped to Site or Web and have a specific needsUpgrade state.
Public method QueryFeatures(Guid, Boolean) Retrieves all features in the current Web application that are scoped to Site or Web and have the specified feature identifier and requirement for upgrade.
Public method QueryFeatures(Guid, Version) Retrieves all features in the current Web application that are scoped to Site or Web and have the specified feature and version identifiers.
Protected method RemoveIdentityFromLocalGroups Removes the current application pool from local groups if it is not used by other Web applications on the server.
Public method RenameApplicationPool Renames the application pool on all servers and updates the database.
Public method SetDailyUnthrottledPrivilegedOperationWindow Sets the daily unthrottled window.
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() Unprovisions the Web application and removes it from all local Internet Information Services (IIS) Web sites. (Overrides SPPersistedObject.Unprovision().)
Public method Unprovision(Boolean) Unprovisions the Web application and optionally removes the application from all local Internet Information Services (IIS) Web sites.
Public method UnprovisionGlobally() Removes the Web application from all front-end Web servers.
Public method UnprovisionGlobally(Boolean) Removes the Web application from all front-end Web servers and optionally removes the Internet Information Services (IIS) Web sites.
Public method Update() Causes the Web application to serialize its state and propagate changes throughout the server farm. (Overrides SPPersistedObject.Update().)
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.)
Public method UpdateCredentials Updates credentials in the database when a username or password changes.
Public method UpdateMailSettings Updates the e-mail settings that are used when SharePoint Foundation sends email.
Public method UpdateMappedPage Updates the custom application page mapping.
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateSmsAccount Assigns to the Web application the account with a mobile messaging service provider that is used by mobile alerts.
Public method UpdateWorkflowConfigurationSettings Reads the web.config file and copies its content as settings.
Public method Upgrade() Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
Public method Upgrade(Boolean) Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
Protected method Validate Validates the state of the Web application before persisting the object. (Overrides SPPersistedObject.Validate().)
Public method ValidateBackwardsCompatibility Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.)
Public method ZonePolicies Returns the set of policies that apply to the specified zone.

Top

Fields

  Name Description
Protected field m_BrowserCEIPEnabled

Top

See Also

Reference

SPWebApplication Class

Microsoft.SharePoint.Administration Namespace