AddinSettings members

Represents the settings of a site services add-in.

The AddinSettings type exposes the following members.

Constructors

  Name Description
Public method AddinSettings(ClientRuntimeContext, ObjectPath) Initializes a new instance of the Addin Settings object.
Public method AddinSettings(ClientRuntimeContext, Guid) Initializes a new instance of the AddinSettings object.

Top

Properties

  Name Description
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property Description Gets or sets a String that describes the Addin Settings.
Public property Enabled Gets or sets a Boolean that indicates whether Addin Settings is enabled or not.
Public property HeadScript Gets or sets the contents of the head script in the Addin Settings.
Public property HtmlEndBody Gets or sets the value of the HTML end body tag in the Addin Settings.
Public property HtmlStartBody Gets or sets the contents of the HTML start body tag in the Addin Settings.
Public property Id Gets the identifier of the Addin Settings
Public property MetaTagPagePropertyMappings Gets or sets the <meta> tag and page property mappings for the Addin Settings.
Public property Namespace Gets or sets the namespace for the Addin Settings.
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 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 ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property Title Gets or sets the value of the Title property of the AddinSettings AddinSettings object.
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)

Top

Methods

  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 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 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.)
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 Initializes one property of the client object based on JavaScript Object Notation (JSON) data from the server. (Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).)
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 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 ToString (Inherited from Object.)
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

See also

Reference

AddinSettings class

Microsoft.SharePoint.Client.Publishing namespace