Click or drag to resize

BaseWebDefinition Class

Specifies a SharePoint web.
Inheritance Hierarchy

Namespace:  Colygon.MatchPoint.Provisioning.ObjectDefinitions
Assembly:  Colygon.MatchPoint (in Colygon.MatchPoint.dll) Version: 2019.2.1.0
Syntax
C#
[SerializableAttribute]
public abstract class BaseWebDefinition : BaseObjectDefinition

The BaseWebDefinition type exposes the following members.

Constructors
  NameDescription
Protected methodBaseWebDefinition
Initializes a new instance of the BaseWebDefinition class
Top
Properties
  NameDescription
Public propertyFeatures
Contains features that are activated by this provisioning configuration.
Top
Methods
  NameDescription
Protected methodActivateFeatures(SPWeb)
Protected methodStatic memberActivateFeatures(SPWeb, IEnumerableFeatureDefinition)
Protected methodApplyComposedLook
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetAsMasterPageUrl
Protected methodGetDefaultFeatures
Protected methodGetFromMasterPageUrl
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPostProvision
Public methodProvision(ProvisioningContext)
Public methodProvision(SPWeb, Boolean)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldBaseTemplate
Specifies the base template which is applied before the provisioning is done. Allowed values are published base templates (e.g. "STS#0") or MatchPoint Provisioning configurations (e.g. "ProvisioningConfiguration.xml").
Public fieldComposedLook
Specifies the composed look for the new web. The composed look of the parent web will be used if none is specified.
Public fieldContentTypes
Contains definitions for content types that are to be created by this provisioning configuration.
Public fieldCulture
Specifies the culture for the new web. E.g.: 'en-US' for English (United States).
Public fieldCustomMasterPageUrl
Specifies the default master file. At runtime, the value in this property replaces the ~masterurl/default.master token in content pages. Provide a master page file name for master pages located in '_catalogs/masterpages', a web relative master page URL ('SomeLibrary/file.master') or a server relative page url if the master file is located in a parent web.
Public fieldDescription
Specifies the description of the web.
Public fieldDescriptionResource
Contains string translations for the description parameter in different languages.
Public fieldFolderSettings
Contains folder settings of this container element.
Public fieldLanguageSettings
Specifies the language settings for the multi language user interface support.
Public fieldLists
Contains lists which are created or modified by this provisioning configuration.
Public fieldLogoUrl
Specifies the logo URL for the new web. The logo from the parent web will be used if empty.
Public fieldMasterPageUrl
Specifies the default master file. At runtime, the value in this property replaces the ~masterurl/default.master token in content pages. Provide a master page file name for master pages located in '_catalogs/masterpages', a web relative master page URL ('SomeLibrary/file.master') or a server relative page url if the master file is located in a parent web.
Public fieldPermissionAssignments
Contains permission assignment definitions for this object.
(Inherited from BaseObjectDefinition.)
Public fieldPortalName
Specifies the friendly name for the portal. This setting is only used when a site collection is created.
Public fieldPortalUrl
Specifies the URL for the portal. This setting is only used when a site collection is created.
Public fieldProvisioningLanguage
Specifies the language of the names specified to reference other objects (e.g. lists, content types, etc.) or to resolve StringResources. The specified language has to exist in the LanguageSettings. The language of the web will be taken if left empty.
Public fieldRemoveWebParts
If enabled, the existing Web Parts on the page are removed.
Public fieldSiteColumns
Contains definitions for columns that are to be created by this provisioning configuration.
Public fieldTags
Specifies a list of tags which will be applied to the current object.
(Inherited from BaseObjectDefinition.)
Public fieldTitle
Public fieldTitleResource
Contains string translations for the title parameter in different languages.
Public fieldWebParts
Contains configurations for Web Parts that are placed on the default page of the web.
Public fieldWelcomePageUrl
Specifies the web relative url of the page that should be used as landing page. A user accessing the web will be redirected to this url. If left empty, the default welcome page of the base template will be used.
Top
Remarks
This object can be used within a ProvisioningConfiguration. Changes do not require the provisioning configuration to be re-published.

It is possible to extend this type for implementing custom web definitions for the provisioning mechanism. Custom functionality can be provided by implementing the Provision(ProvisioningContext) and PostProvision(ProvisioningContext) methods.

#APIChange 4.0: Theme replaced by ComposedLook
Remarks
This is a MatchPoint configuration class.
See Also