ArcGIS Pro 3.3 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / StyleProjectItem Class


In This Topic
    StyleProjectItem Class Methods
    In This Topic

    For a list of all members of this type, see StyleProjectItem members.

    Public Methods
     NameDescription
    Public MethodCanEdit 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 MethodCanUnreferenceStyleGets a value which indicates whether a StyleProjectItem can be unreferenced.  
    Public MethodCopyMetadataFromItem Copy metadata from Item. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodDeleteMetadataContent 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 MethodDisposeImplements the dispose method (of System.IDisposable)  
    Public MethodEquals Determines if the given object is identical to this object. (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodExportMetadataOverloaded.  (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodGetCountsGets the StyleItemType counts that are contained within a StyleProjectItem  
    Public MethodGetHashCode Gets a hash code associated with this item. (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodGetItems 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 MethodGetXml 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 MethodImportMetadataOverloaded.  (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodIsContentLoading Checks if the style content is loading  
    Public MethodOnCurrentRoot Called when the Item becomes the current root item in the Catalog View. (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodOnExpanded Override to implement any custom logic when your item is expanded (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodRefreshRefreshes 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 MethodRepair Repair the path (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodSaveMetadataAsHTML 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 MethodSaveMetadataAsUsingCustomXSLT 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 MethodSaveMetadataAsXML 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 MethodSearchItem Search (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodSetAlias 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 MethodSetXml 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 MethodSynchronize 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 MethodToString Override the default ToString() method. (Inherited from ArcGIS.Desktop.Core.Item)
    Public MethodUpgradeMetadata 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 MethodAddRangeToChildrenAdds the collection of items to the item's child collection (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal MethodClearChildrenRemoves all items from the item's child collection (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal MethodGetChildren Gets the children of this item (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal MethodGetContainerType Gets the container type (Inherited from ArcGIS.Desktop.Core.Item)
    Protected MethodGetRepairPathOverridden.   
    Protected Internal MethodHasChildCheck if the item contains the specified child item in its child collection (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal MethodInsertChildInsert the child item into the item's child collection at the specified index (Inherited from ArcGIS.Desktop.Core.Item)
    Protected MethodNotifyPropertyChangedOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal MethodOnFolderRename Callback when an item's parent folder is being renamed (Inherited from ArcGIS.Desktop.Core.Item)
    Protected MethodOnSearchResetOverridden.   
    Protected Internal MethodRemoveChildRemove the specified item from the item's child collection (Inherited from ArcGIS.Desktop.Core.Item)
    Protected Internal MethodRemoveRangeFromChildren Remove the collection of items from the item's child collection (Inherited from ArcGIS.Desktop.Core.Item)
    Protected MethodSetPropertyOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal MethodUnlinkPortalItem Derived classes can override this method (Inherited from ArcGIS.Desktop.Core.Item)
    Top
    Extension Methods
     NameDescription
    Public Extension MethodAddItem Adds a style item to a style. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension MethodLookupItem Retrieves a specific style item from a style. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension MethodRemoveItem Removes a style item from a style. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension MethodSearchColorRamps 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 MethodSearchColors 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 MethodSearchDimensionStyles 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 MethodSearchGrids 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 MethodSearchLabelPlacements 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 MethodSearchLegendItems 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 MethodSearchLegends 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 MethodSearchMapSurrounds 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 MethodSearchNorthArrows 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 MethodSearchScaleBars 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 MethodSearchSymbols 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 MethodSearchTableFrameFields 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 MethodSearchTableFrames 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 MethodUpdateItem Updates a style item from a style. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension MethodUpgradeStyle Upgrades the specified style to the current ArcGIS Pro version. This method must be called on the MCT. Use QueuedTask.Run.
    Top
    See Also

    Reference

    StyleProjectItem Class
    ArcGIS.Desktop.Mapping Namespace

     

     

    ©2024 Esri Inc., All Rights Reserved. Generated on Monday, April 22, 2024

    Send feedback