ArcGIS Pro 3.0 API Reference Guide
ArcGIS.Desktop.Core Namespace / Project Class


In This Topic
Project Class Methods
In This Topic

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

Public Methods
 NameDescription
Public MethodAddItemAdds the item to the current project. This method must be called on the MCT. Use QueuedTask.Run.  
Public MethodCanEdit Indicates if metadata is editable for the item.  
Public Methodstatic (Shared in Visual Basic)CanOpenChecks if the specified project or project package can be opened  
Public Methodstatic (Shared in Visual Basic)ClearRecentProjects Clears the list of recent projects  
Public MethodCopyMetadataFromItem Copy metadata from Item. This method must be called on the MCT. Use QueuedTask.Run.  
Public Methodstatic (Shared in Visual Basic)CreateAsync Creates a new project with properties determined by CreateProjectSettings  
Public MethodDeleteMetadataContent Delete certain content from the metadata of the current item. This method must be called on the MCT. Use QueuedTask.Run.  
Public MethodDiscardEditsAsyncDiscards all unsaved data edits in the project  
Public MethodExportMetadataOverloaded.   
Public MethodFindItem Find the item identified by the physical path.  
Public Methodstatic (Shared in Visual Basic)GetActiveCatalogWindow Gets the active catalog view or null if no catalog view is active  
Public Methodstatic (Shared in Visual Basic)GetCatalogPaneGets the catalog pane. If createIfNecessary = true and the catalog pane has not been created, the pane will be created. Otherwise, if the catalog pane has not been created and createIfNecessary = false, null will be returned  
Public Methodstatic (Shared in Visual Basic)GetDefaultProjectSettings Get the default project settings  
Public MethodGetItems<T>Gets a collection of a specific type of items within the project  
Public MethodGetProjectItemContainer Get the container with the given key. Container keys are not localized. A container is needed only in those situations where you want to select a specific item that occurs in more than one container.  
Public Methodstatic (Shared in Visual Basic)GetRecentProjects Retrieves the list of recently opened projects  
Public MethodGetXml Gets the item’s metadata XML document as a string. This method must be called on the MCT. Use QueuedTask.Run.  
Public MethodImportItemOverloaded.   
Public MethodImportMetadataOverloaded.   
Public Methodstatic (Shared in Visual Basic)OpenAsync Opens an existing project or project package  
Public MethodRedoEditAsyncRestores the last data edit that was reversed in the project  
Public MethodRemoveItemRemoves the project item from the current project. This method must be called on the MCT. Use QueuedTask.Run.  
Public MethodRemoveItemsRemoves project items from the current project. This method must be called on the MCT. Use QueuedTask.Run.  
Public Methodstatic (Shared in Visual Basic)RemoveRecentProject Removes the project entry corresponding to the given input path from the recent list of projects  
Public MethodRepairProjectItems  
Public MethodSaveAsAsync Saves a copy of the current project file (*.aprx) to the specified location with the specified file name, then opens the new project file  
Public MethodSaveAsync Saves the project  
Public MethodSaveEditsAsyncSave all unsaved data edits in the project  
Public MethodSaveFromUntitled Creates a new project from an untitled session  
Public MethodSaveMetadataAsHTML Save the metadata of the current item as HTML. This method must be called on the MCT. Use QueuedTask.Run.  
Public MethodSaveMetadataAsUsingCustomXSLT Save the metadata of the current item using customized XSLT. This method must be called on the MCT. Use QueuedTask.Run.  
Public MethodSaveMetadataAsXML Save the metadata of the current item as XML. This method must be called on the MCT. Use QueuedTask.Run.  
Public MethodSearchAsyncSearches the project for items that match the provided criteria  
Public MethodSetDefaultGeoDatabasePath Sets the current project's default geodatabase. This method must be called on the MCT. Use QueuedTask.Run.  
Public MethodSetDefaultToolboxPath Sets the current project's default toolbox. This method must be called on the MCT. Use QueuedTask.Run.  
Public MethodSetDirty Sets the dirty state of the project  
Public MethodSetHomeFolderPath Sets the current project's home folder. This method must be called on the MCT. Use QueuedTask.Run.  
Public MethodSetIsEditingEnabledAsync Sets a value that indicates if editing is to be enabled or disabled within the application.  
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.  
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.  
Public MethodUndoEditAsyncReverses the last data edit in the project  
Public MethodUpgradeMetadata Upgrade the metadata of the current item. This method must be called on the MCT. Use QueuedTask.Run.  
Top
Protected Methods
 NameDescription
Protected MethodNotifyPropertyChangedOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
Protected MethodSetPropertyOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
Top
Extension Methods
 NameDescription
Public Extension MethodAddStyle Adds the specified style to the current project. This method must be called on the MCT. Use QueuedTask.Run.
Public Extension MethodCreateMobileStyle Creates a new mobile style file (.stylx) on disk and adds the mobile style to the current project. This method must be called on the MCT. Use QueuedTask.Run.
Public Extension MethodCreateStyle Creates a new style file (.stylx) on disk and adds the style to the current project. This method must be called on the MCT. Use QueuedTask.Run.
Public Extension MethodGetBookmarks Returns the project's collection of bookmarks. This method must be called on the MCT. Use QueuedTask.Run.
Public Extension MethodRemoveStyle Removes the specified style from the current project. This method must be called on the MCT. Use QueuedTask.Run.
Top
See Also

Reference

Project Class
ArcGIS.Desktop.Core Namespace

 

 

©2022 Esri Inc., All Rights Reserved. Generated on Monday, June 13, 2022

Send feedback