Export (0) Print
Expand All

Site members

Represents a collection of sites in a Web application, including a top-level website and all its subsites.

The Site type exposes the following members.

  Name Description
Public method Site Initializes a new instance of the Site object.
Top

  Name Description
Public property AllowCreateDeclarativeWorkflow
Public property AllowDesigner Gets or sets a value that specifies whether a designer can be used on this site collection.
Public property AllowMasterPageEditing Gets or sets a value that specifies whether master page editing is allowed on this site collection.
Public property AllowRevertFromTemplate Gets or sets a value that specifies whether this site collection can be reverted to its base template.
Public property AllowSaveDeclarativeWorkflowAsTemplate
Public property AllowSavePublishDeclarativeWorkflow
Public property AllowSelfServiceUpgrade Whether version to version upgrade is allowed on this site.
Public property AllowSelfServiceUpgradeEvaluation Whether upgrade evaluation site collection is allowed.
Public property CanUpgrade Property indicating whether or not this object can be upgraded.
Public property CompatibilityLevel Gets the major version of this site collection for purposes of major version-level compatibility checks.
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property EventReceivers Provides event receivers for events that occur at the scope of the site collection.
Public property ExternalSharingTipsEnabled
Public property Features Gets a value that specifies the collection of the site collection features for the site collection that contains the site.
Public property Id
Public property LockIssue Gets or sets the comment that is used in locking a site collection.
Public property MaxItemsPerThrottledOperation Gets a value that specifies the maximum number of list items allowed per operation before throttling will occur.
Public property NeedsB2BUpgrade
Protected property ObjectData Gets the object data for the current client object. (Inherited from ClientObject.)
Public property ObjectVersion Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property Owner Gets or sets the owner of the site collection. (Read-only in sandboxed solutions.)
Public property Path Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property PrimaryUri Specifies the primary URI of this site collection, including the host name, port number, and path.
Public property ReadOnly Gets or sets a Boolean value that specifies whether the site collection is read-only, locked, and unavailable for write access.
Public property RecycleBin Gets a value that specifies the collection of Recycle Bin items for the site collection.
Public property RequiredDesignerVersion
Public property RootWeb Gets a value that returns the top-level site of the site collection.
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property ServerRelativeUrl Gets the server-relative URL of the root Web site in the site collection.
Public property ShareByEmailEnabled
Public property ShareByLinkEnabled Property that indicates whether users will be able to share links to documents that can be accessed without logging in.
Public property ShowUrlStructure Gets or sets a value that specifies whether the URL structure of this site collection is viewable.
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
Public property UIVersionConfigurationEnabled Gets or sets a value that specifies whether the Visual Upgrade UI of this site collection is displayed.
Public property UpgradeInfo Specifies the upgrade information of this site collection.
Public property UpgradeReminderDate Specifies a date, after which site collection administrators will be reminded to upgrade the site collection.
Public property UpgradeScheduled
Public property UpgradeScheduledDate
Public property Upgrading Specifies whether the site is currently upgrading.
Public property Url Gets the full URL to the root Web site of the site collection, including host name, port number, and path.
Public property Usage Gets a value that specifies usage information about the site, including bandwidth, storage, and the number of visits to the site collection.
Public property UserCustomActions Gets a value that specifies the collection of user custom actions for the site collection.
Top

  Name Description
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method CreatePreviewSPSite Creates a temporary evaluation Site object for this Site object, for the purposes of determining whether upgrade is likely to be successful.
Public method CustomFromJson Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method ExtendUpgradeReminderDate Extend the upgrade reminder date for this Site by the days specified at WebApplication.UpgradeReminderDelay.
Public method FromJson Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method GetCatalog Specifies the list template gallery, site template gallery, Web Part gallery, master page gallery, or other galleries from the site collection, including custom galleries that are defined by users.
Public method GetChanges Specifies the collection of the site collection changes from the change log that have occurred within the scope of the site collection, based on the specified query.
Public method GetCustomListTemplates Specifies the collection of custom list templates for a given site.
Public method GetWebTemplates Returns the collection of site definitions that are available for creating websites within the site collection.
Protected method InitNonPropertyFieldFromJson Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Protected method InitOnePropertyFromJson (Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).)
Public method Invalidate Implements the IUpgradeable interface.
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Protected method LoadExpandoFields Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method NeedsUpgradeByType true if the object needs to be upgraded; otherwise, false.
Public method OpenWeb Opens a new site using the specified URL.
Public method OpenWebById Returns the site with the specified GUID.
Public method RefreshLoad Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method Retrieve() Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method Retrieve([]) Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method RunHealthCheck Runs a health check as follows. (The health rules referenced below perform an implementation-dependent check on the health of a site collection.)If ruleId is not an empty GUID, runs the specified site collection health rule and returns a summary of the results. If ruleId is an empty GUID, runs all of the site collection health rules and returns a summary of the results.If bRepair is true, runs the specified rules in repair mode. In this case, and if a given rule is repairable, an attempt will be made to repair issues found by the rule, and the results from that attempted repairs are returned. If bRepair is false, an attempt to repair issues found is not made.If bRunAlways is true, rules are always run by this method, and the results are returned. If false, cached results from a recent previous run can be returned instead.
Public method RunUpgradeSiteSession Either runs a site collection upgrade, or schedules it to be run in the future, depending on available system resources and the value of the queueOnly parameter.The user executing this method MUST be a farm administrator or a site collection administrator.
Public method ToString (Inherited from Object.)
Public method UpdateClientObjectModelUseRemoteAPIsPermissionSetting Sets whether the client-side object model (CSOM) requests that are made in the context of any site inside the site collection require UseRemoteAPIs permission.
Protected method UpdateClientObjectPropertyType Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)
Top
Show:
© 2014 Microsoft