Export (0) Print
Expand All

List members

Represents a list on a SharePoint Web site.

The List type exposes the following members.

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

  Name Description
Public property AllowContentTypes Gets a value that specifies whether the list supports content types.
Public property BaseTemplate Gets the list definition type on which the list is based.
Public property BaseType Gets the base type for the list.
Public property BrowserFileHandling Gets a value that specifies the override of the web application’s BrowserFileHandling property at the list level.
Public property ContentTypes Gets the content types that are associated with the list.
Public property ContentTypesEnabled Gets or sets a value that specifies whether content types are enabled for the list.
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property CreatablesInfo
Public property Created Gets a value that specifies when the list was created.
Public property DataSource Gets the data source associated with the list, or a null reference (Nothing in Visual Basic) if the list is not a virtual list.
Public property DefaultContentApprovalWorkflowId Gets or sets a value that specifies the default workflow identifier for content approval on the list.
Public property DefaultDisplayFormUrl Gets or sets a value that specifies the location of the default display form for the list.
Public property DefaultEditFormUrl Gets or sets a value that specifies the URL of the edit form to use for list items in the list.
Public property DefaultNewFormUrl Gets or sets a value that specifies the location of the default new form for the list.
Public property DefaultView
Public property DefaultViewUrl Gets the URL of the default view for the list.
Public property Description Gets or sets a value that specifies the description of the list.
Public property DescriptionResource
Public property Direction Gets or sets a value that specifies the reading order of the list.
Public property DocumentTemplateUrl Gets or sets a value that specifies the server-relative URL of the document template for the list.
Public property DraftVersionVisibility Gets or sets a value that specifies the minimum permission required to view minor versions and drafts within the list.
Public property EffectiveBasePermissions Gets a value that specifies the effective permissions on the list that are assigned to the current user.
Public property EffectiveBasePermissionsForUI
Public property EnableAttachments Gets or sets a value that specifies whether list item attachments are enabled for the list.
Public property EnableFolderCreation Gets or sets a value that specifies whether new list folders can be added to the list.
Public property EnableMinorVersions Gets or sets a value that specifies whether minor versions are enabled for the list.
Public property EnableModeration Gets or sets a value that specifies whether content approval is enabled for the list.
Public property EnableVersioning Gets or sets a value that specifies whether historical versions of list items and documents can be created in the list.
Public property EntityTypeName
Public property EventReceivers
Public property Fields Gets a value that specifies the collection of all fields in the list.
Public property FirstUniqueAncestorSecurableObject Gets the object where role assignments for this object are defined. (Inherited from SecurableObject.)
Public property ForceCheckout
Public property Forms Gets a value that specifies the collection of all list forms in the list.
Public property HasExternalDataSource Gets a value that specifies whether the list is an external list.
Public property HasUniqueRoleAssignments Gets a value that specifies whether the role assignments are uniquely defined for this securable object or inherited from a parent securable object. (Inherited from SecurableObject.)
Public property Hidden Gets or sets a Boolean value that specifies whether the list is hidden.
Public property Id Gets the GUID that identifies the list in the database.
Public property ImageUrl Gets a value that specifies the URI for the icon of the list.
Public property InformationRightsManagementSettings
Public property IrmEnabled
Public property IrmExpire
Public property IrmReject
Public property IsApplicationList Gets or sets a value that specifies a flag that a client application can use to determine whether to display the list.
Public property IsCatalog Gets a value that specifies whether the list is a gallery.
Public property IsPrivate
Public property IsSiteAssetsLibrary
Public property ItemCount Gets a value that specifies the number of list items in the list.
Public property LastItemDeletedDate Gets a value that specifies the last time a list item was deleted from the list.
Public property LastItemModifiedDate Gets a value that specifies the last time a list item, field, or property of the list was modified.
Public property ListItemEntityTypeFullName
Public property MultipleDataList
Public property NoCrawl Gets or sets a value that specifies that the crawler must not crawl the list.
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 OnQuickLaunch Gets or sets a value that specifies whether the list appears on the Quick Launch of the site.
Public property ParentWeb Gets a value that specifies the site that contains the list.
Public property ParentWebUrl Gets a value that specifies the server-relative URL of the site that contains the list.
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 RoleAssignments Gets the role assignments for the securable object. (Inherited from SecurableObject.)
Public property RootFolder Gets the root folder that contains the files in the list and any related files.
Public property SchemaXml Gets a value that specifies the list schema of the list.
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property ServerTemplateCanCreateFolders
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property TemplateFeatureId Gets a value that specifies the feature identifier of the feature that contains the list schema for the list.
Public property Title Gets or sets the displayed title for the list.
Public property TitleResource
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
Public property UserCustomActions Gets a value that specifies the collection of all user custom actions for the list.
Public property ValidationFormula Gets or sets a value that specifies the data validation criteria for a list item.
Public property ValidationMessage Gets or sets a value that specifies the error message returned when data validation fails for a list item.
Public property Views Gets a value that specifies the collection of all public views on the list and personal views of the current user on the list.
Public property WorkflowAssociations Gets a value that specifies the collection of all workflow associations for the list.
Top

  Name Description
Public method AddItem Creates a new list item in the list.
Public method BreakRoleInheritance Creates unique role assignments for the securable object. (Inherited from SecurableObject.)
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method CreateDocument
Public method CreateDocumentAndGetEditLink
Public method CreateDocumentFromTemplate
Public method CreateDocumentFromTemplateBytes
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 DeleteObject Deletes the list.
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 GetChanges Returns the collection of changes from the change log that have occurred within the list, based on the specified query.
Public method GetItemById(Int32) Returns the list item with the specified list item identifier.
Public method GetItemById(String)
Public method GetItems Returns a collection of items from the list based on the specified query.
Public method GetRelatedFields Returns a collection of lookup fields that use this list as a data source and that have FieldLookup.IsRelationship set to true.
Public method GetUserEffectivePermissions
Public method GetView Returns the list view with the specified view identifier.
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 SecurableObject.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 Recycle Moves the list to the Recycle Bin and returns the identifier of the new Recycle Bin item.
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 RenderListContextMenuData
Public method RenderListData
Public method RenderListDataAsStream
Public method RenderListFilterData
Public method RenderListFormData
Public method ReserveListItemId
Public method ResetRoleInheritance When implemented in a derived class, removes local role assignments so that role assignments, for all descendant objects, are re-inherited from the parent object. (Inherited from SecurableObject.)
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 SaveAsNewView
Public method ToString (Inherited from Object.)
Public method Update Updates the database with changes that are made to the list.
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