ArcGIS Pro 3.2 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / StyleProjectItem Class
Fields Properties Methods Events


In This Topic
    StyleProjectItem Class Members
    In This Topic

    The following tables list the members exposed by StyleProjectItem.

    Public Fields
     NameDescription
    Public Field Gets the default IconViewPreviewSize  
    Top
    Public Properties
     NameDescription
    Public Property Gets documented limitations with respect to using the item. Derived from Use Limitations defined in the item's metadata. (Inherited from ArcGIS.Desktop.Core.Item)
    Public PropertyGets and sets the alias of the item. The setter for this property changes the value for this application session, but will not result in the new value being persisted for the next session even if changes to the project are saved. If the new value needs to be saved with other project changes, use the ArcGIS.Desktop.Core.Item.SetAlias method. (Inherited from ArcGIS.Desktop.Core.Item)
    Public PropertyGets the value which indicates if the StyleProjectItem can be upgraded to the current ArcGIS Pro version.  
    Public Property Gets information that gives credit to the producer or provider of the item. Derived from Credits defined in the item's metadata. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets and sets a description of the item. Derived from the Description or Abstract defined in the item's metadata. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets the item file size (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets a unique identifier for the item (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets a unique identifier associated with each portal item (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets if the item contains other items (Inherited from ArcGIS.Desktop.Core.Item)
    Public PropertyGets the value which indicates if the StyleProjectItem is using the current ArcGIS Pro version.  
    Public Property Gets whether the style item is a custom style.  
    Public Property Gets if the item has been set as a default for this project (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets if the item is invalid (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Returns whether the Item must be refreshed on the MCT within the lambda of a QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets whether the style item is a mobile style.  
    Public PropertyGets the value which indicates if the StyleProjectItem is read-only.  
    Public Property Gets a list of the item categories in which the item participates (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets the maximum map scale at which the item should draw (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets the minimum map scale at which the item should draw (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets and sets the name of the item (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets the path used to access the item (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets and sets the location where the item is stored (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets and sets the time when the item's source item was last modified (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets and sets a Uri that identifies the source item from which the item was created in the project (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets and sets a summary describing the purpose of the item. Derived from the Summary or Purpose defined in the item's metadata. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets and sets a comma-separated list of tags that describe the item. Derived from Tags defined in the item's metdata. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets and sets a path to a thumbnail that describes and helps to identify the item. Derived from the Thumbnail that is extracted from the item's metadata. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets and sets a descriptive title for the item. Derived from the Title in the item's metadata. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets a localized string indicating the item's type, for example, shapefile (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets the type identifier that indicates what icon, context menu, and operations the item should have (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets keywords associated with the item's type that support finding the item with a search (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets a URL that can be used to access the item (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets the maximum value along the x-axis for the item's minimum bounding rectangle (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets the minimum value along the x-axis for the item's minimum bounding rectangle (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets the maximum value along the y-axis for the item's minimum bounding rectangle (Inherited from ArcGIS.Desktop.Core.Item)
    Public Property Gets the minimum value along the y-axis for the item's minimum bounding rectangle (Inherited from ArcGIS.Desktop.Core.Item)
    Top
    Protected Properties
     NameDescription
    Protected Internal Property Gets whether to block from the cache (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal PropertyGets the category for this item (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal PropertyGets and sets the container type for this item (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal Property Gets the item creation time (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal PropertyGets and sets the last modified time for this item (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal PropertyGets and sets the display type string (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal PropertyGets and sets the group sort order for the item. (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal PropertyChecks whether the item has child items in its child item collection (Inherited from ArcGIS.Desktop.Core.Item)
    Protected PropertyGets whether the item is searchable. Default is true (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal PropertyGets the associated key for this item (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal PropertyGets and sets the project item sort order for the item. (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal PropertyGets whether the item supports a date. The default is true (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal PropertyGets whether the item supports an owner. The default is false (Inherited from ArcGIS.Desktop.Core.Item)
    Top
    Public Methods
     NameDescription
    Public Method Indicates if metadata is editable for the item. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodGets a value which indicates whether a StyleProjectItem can be unreferenced.  
    Public Method Copy metadata from Item. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Delete certain content from the metadata of the current item. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodImplements the dispose method (of System.IDisposable)  
    Public Method Determines if the given object is identical to this object. (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodOverloaded.  (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodGets the StyleItemType counts that are contained within a StyleProjectItem  
    Public Method Gets a hash code associated with this item. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Browses the contents of an item. Returns a snapshot collection of of the item's children. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Gets the item’s metadata XML document as a string. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodOverloaded.  (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Checks if the style content is loading  
    Public Method Called when the Item becomes the current root item in the Catalog View. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Override to implement any custom logic when your item is expanded (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodRefreshes the collection of children. Use ArcGIS.Desktop.Core.Item.IsMainThreadRequired to determine the correct thread for performing a refresh. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Repair the path (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Save the metadata of the current item as HTML. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Save the metadata of the current item using customized XSLT. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Save the metadata of the current item as XML. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Search (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Changes the alias value on the given item. This method will return false if the item is not a folder connection. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Sets the item’s metadata to the XML document provided as a string. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Updates metadata with the current properties of the item. Metadata is created for the item if it doesn't already exist. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Override the default ToString() method. (Inherited from ArcGIS.Desktop.Core.Item)
    Public Method Upgrade the metadata of the current item. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Top
    Protected Methods
     NameDescription
    Protected Internal MethodAdds the collection of items to the item's child collection (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal MethodRemoves all items from the item's child collection (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal Method Gets the children of this item (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal Method Gets the container type (Inherited from ArcGIS.Desktop.Core.Item)
    Protected MethodOverridden.   
    Protected Internal MethodCheck if the item contains the specified child item in its child collection (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal MethodInsert the child item into the item's child collection at the specified index (Inherited from ArcGIS.Desktop.Core.Item)
    Protected MethodOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal Method Callback when an item's parent folder is being renamed (Inherited from ArcGIS.Desktop.Core.Item)
    Protected MethodOverridden.   
    Protected Internal MethodRemove the specified item from the item's child collection (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal Method Remove the collection of items from the item's child collection (Inherited from ArcGIS.Desktop.Core.Item)
    Protected MethodOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal Method Derived classes can override this method (Inherited from ArcGIS.Desktop.Core.Item)
    Top
    Extension Methods
     NameDescription
    Public Extension Method Adds a style item to a style. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Retrieves a specific style item from a style. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Removes a style item from a style. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of color ramp style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of color style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of dimension style style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of grid style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of label placement style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of legend item style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of legend style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of map surround style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of north arrow style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of scale bar style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of symbol style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of table frame field style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Returns a collection of table frame style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Updates a style item from a style. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Upgrades the specified style to the current ArcGIS Pro version. This method must be called on the MCT. Use QueuedTask.Run.
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also