ArcGIS Pro 3.4 API Reference Guide
ArcGIS.Desktop.Core Namespace / Project Class
Properties Methods Events


In This Topic
    Project Class Members
    In This Topic

    The following tables list the members exposed by Project.

    Public Properties
     NameDescription
    Public Property Gets documented limitations with respect to using the item. Derived from Use Limitations defined in the item's metadata.  
    Public Property Gets information that gives credit to the producer or provider of the item. Derived from Credits defined in the item's metadata.  
    Public Propertystatic (Shared in Visual Basic) Gets the project that is currently open in the ArcGIS Pro application  
    Public Property Gets the current project's default geodatabase  
    Public Property Gets the current project's default toolbox  
    Public Property Gets a description of the item. Derived from the Description or Abstract defined in the item's metadata.  
    Public PropertyReturns the data stores that have pending edits which have not been saved. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Property Gets a unique identifier for the item  
    Public PropertyGets if there are any unsaved data edits in the project  
    Public Property Gets the current project's home folder  
    Public Property Gets the dirty state of the project  
    Public Property Gets a value that indicates if editing is enabled.  
    Public Property If true, this project is a portal project.  
    Public Property Gets whether the portal project is downloading  
    Public Property Gets whether the portal project is being merged  
    Public PropertyGets whether the portal project is uploading  
    Public PropertyGets the current project's collection of project items  
    Public Property Gets the maximum map scale at which the item should draw  
    Public Property Gets the minimum map scale at which the item should draw  
    Public Property Gets the name of the project  
    Public Property Gets the project path  
    Public Property Gets the location where the item (i.e. project) is stored  
    Public Property Gets the list of project item containers  
    Public Property Gets if the project is opened in a read-only state  
    Public Property Gets the items that are currently selected in the Project pane or the Project view  
    Public Property Gets the time when the item's source item was last modified  
    Public Property Gets a summary describing the purpose of the item. Derived from the Summary or Purpose defined in the item's metadata.  
    Public Property Gets a comma-separated list of tags that describe the item. Derived from Tags defined in the item's metdata.  
    Public Property Gets 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.  
    Public Property Gets a descriptive title for the item. Derived from the Title in the item's metadata.  
    Public Property Gets a localized string indicating the item's type, for example, shapefile  
    Public Property Gets keywords associated with the item's type that support finding the item with a search  
    Public Property Gets if the project is opened in a read-only state  
    Public Property Gets the location of the current project; that is, the path to the current project file (*.aprx)  
    Public Property Gets a URL that can be used to access the item  
    Public Property Gets the maximum value along the x-axis for the item's minimum bounding rectangle  
    Public Property Gets the minimum value along the x-axis for the item's minimum bounding rectangle  
    Public Property Gets the maximum value along the y-axis for the item's minimum bounding rectangle  
    Public Property Gets the minimum value along the y-axis for the item's minimum bounding rectangle  
    Top
    Public Methods
     NameDescription
    Public MethodAdds the item to the current project. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Indicates if metadata is editable for the item.  
    Public Methodstatic (Shared in Visual Basic)Checks if the specified project or project package can be opened  
    Public Methodstatic (Shared in Visual Basic) Clears the list of pinned projects.  
    Public Methodstatic (Shared in Visual Basic) Clears the list of recent project templates.  
    Public Methodstatic (Shared in Visual Basic) Clears the list of recent projects.  
    Public Methodstatic (Shared in Visual Basic) Clears the list of recent project templates.  
    Public Method Copy metadata from Item. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Methodstatic (Shared in Visual Basic) Creates a new project with properties determined by CreateProjectSettings  
    Public Method Delete certain content from the metadata of the current item. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodDiscards all unsaved data edits in the project  
    Public MethodOverloaded.   
    Public Method Find the item identified by the physical path.  
    Public Methodstatic (Shared in Visual Basic) Gets the active catalog view or null if no catalog view is active  
    Public Methodstatic (Shared in Visual Basic)Gets 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) Get the default project settings  
    Public MethodGets a collection of a specific type of items within the project  
    Public Methodstatic (Shared in Visual Basic) Retrieves the list of pinned projects.  
    Public Methodstatic (Shared in Visual Basic) Retrieves the list of pinned project templates.  
    Public Method 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) Retrieves the list of recently opened projects  
    Public Methodstatic (Shared in Visual Basic) Retrieves the list of recently opened project templates  
    Public Method Gets the item’s metadata XML document as a string. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverloaded.   
    Public MethodOverloaded.   
    Public Methodstatic (Shared in Visual Basic) Opens an existing project or project package  
    Public Methodstatic (Shared in Visual Basic) Pins a project.  
    Public Methodstatic (Shared in Visual Basic) Pins a project template.  
    Public Method If this project is a portal project, this method updates the project on the portal to match the local version. Local changes and new items will be pushed to the portal. Differences on the portal will be overwritten. New items on the portal will be deleted.  
    Public MethodRestores the last data edit that was reversed in the project  
    Public MethodRemoves the project item from the current project. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodRemoves project items from the current project. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Methodstatic (Shared in Visual Basic) Removes the project entry corresponding to the given input path from the recent list of projects  
    Public Methodstatic (Shared in Visual Basic) Removes the project template entry corresponding to the given input path from the recent list of project templates  
    Public Method  
    Public Method 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 Method Saves the project  
    Public MethodSave all unsaved data edits in the project  
    Public Method Creates a new project from an untitled session  
    Public Method Save the metadata of the current item as HTML. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Save the metadata of the current item using customized XSLT. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Save the metadata of the current item as XML. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSearches the project for items that match the provided criteria  
    Public Method Sets the current project's default geodatabase. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the current project's default toolbox. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the dirty state of the project  
    Public Method Sets the current project's home folder. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the current project's home folder. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets a value that indicates if editing is to be enabled or disabled within the application.  
    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.  
    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.  
    Public MethodReverses the last data edit in the project  
    Public Methodstatic (Shared in Visual Basic) Unpins a project.  
    Public Methodstatic (Shared in Visual Basic) Unpins a project template.  
    Public Method Upgrade the metadata of the current item. This method must be called on the MCT. Use QueuedTask.Run.  
    Top
    Protected Methods
     NameDescription
    Protected MethodOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected MethodOverloaded.   
    Top
    Extension Methods
     NameDescription
    Public Extension Method Adds the specified style to the current project. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method 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 Method 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 Method Returns the project's collection of bookmarks. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Removes the specified style from the current project. 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