CanOpen(String,String) Method
In This Topic
Checks if the specified project or project package can be opened
Syntax
Parameters
- projectOrPackageUri
- The full path or URL to the project or project package that will be opened
- docVersion
- The version of ArcGIS Pro that was used to create the project or project package, for example, "1.0.2" or "1.1.0". A value will not be provided if the
specified item is not recognized as a project.
Return Value
A boolean indicating if the project or project package can be opened
Example
Workflow to open an ArcGIS Pro project
// A portal project path looks like this:
//@"https://<ServerName>.<Domain>.com/portal/sharing/rest/content/items/1a434faebbe7424d9982f57d00223baa";
//A local project path looks like this:
//@"C:\Users\<UserName>\Documents\ArcGIS\Projects\MyProject\MyProject.aprx";
//Check if the project can be opened
if (Project.CanOpen(projectPath, out docVer))
{
//Open the project
await Project.OpenAsync(projectPath);
}
else //The project cannot be opened
{
//One possible reason: If the project is a portal project, the active portal must match the portal of the project
//Check if this is a portal project
bool isPortalProject = Uri.TryCreate(projectPath, UriKind.Absolute, out Uri uriResult)
&& (uriResult.Scheme == Uri.UriSchemeHttp || uriResult.Scheme == Uri.UriSchemeHttps);
if (isPortalProject)
{
//Parse the project path to get the portal
var uri = new Uri(projectPath);
var portalUrlOfProjectToOpen = $"{uri.Scheme}://{uri.Host}/portal/";
//Get the current active portal
var activePortal = ArcGIS.Desktop.Core.ArcGISPortalManager.Current.GetActivePortal();
//Compare to see if the active Portal is the same as the portal of the project
bool isSamePortal = (activePortal != null && activePortal.PortalUri.ToString() == portalUrlOfProjectToOpen);
if (!isSamePortal) //not the same.
{
//Set new active portal to be the portal of the project
//Find the portal to sign in with using its Uri...
var projectPortal = ArcGISPortalManager.Current.GetPortal(new Uri(portalUrlOfProjectToOpen, UriKind.Absolute));
await QueuedTask.Run(() => {
if (!projectPortal.IsSignedOn())
{
//Calling "SignIn" will trigger the OAuth popup if your credentials are
//not cached (eg from a previous sign in in the session)
if (projectPortal.SignIn().success)
{
//Set this portal as my active portal
ArcGISPortalManager.Current.SetActivePortal(projectPortal);
return;
}
}
//Set this portal as my active portal
ArcGISPortalManager.Current.SetActivePortal(projectPortal);
});
//Now try opening the project again
if (Project.CanOpen(projectPath, out docVer))
{
await Project.OpenAsync(projectPath);
}
else
{
System.Diagnostics.Debug.WriteLine("The project cannot be opened.");
}
}
else //The portals are the same. So the problem could be something else - permissions, portal is down?
{
System.Diagnostics.Debug.WriteLine("The project cannot be opened.");
}
}
else //Project is on disk and cannot be opened.
{
System.Diagnostics.Debug.WriteLine("The project cannot be opened.");
}
}
Get the portal from a portal project's path
// A portal project path looks like this:
//@"https://<ServerName>.<Domain>.com/portal/sharing/rest/content/items/1a434faebbe7424d9982f57d00223baa";
//A local project path looks like this:
//@"C:\Users\<UserName>\Documents\ArcGIS\Projects\MyProject\MyProject.aprx";
//Check if the project is a portal project
bool isPortalProject = Uri.TryCreate(projectPath, UriKind.Absolute, out Uri uriResult)
&& (uriResult.Scheme == Uri.UriSchemeHttp || uriResult.Scheme == Uri.UriSchemeHttps);
if (isPortalProject)
{
//Parse the project path to get the portal
var uri = new Uri(projectPath);
var fullUri = $"{uri.Scheme}://{uri.Host}/portal/";
System.Diagnostics.Debug.WriteLine($"The Url of the project is: {fullUri}");
//Now get the ArcGISPortal object from the portal Uri
var arcgisPortal = ArcGISPortalManager.Current.GetPortal(new Uri(fullUri, UriKind.Absolute));
System.Diagnostics.Debug.WriteLine($"The portal of the project is: {arcgisPortal.PortalUri}");
//Note: You can set the active portal to be the portal of the project. Refer to this snippet: [ArcGISPortalManager: Get a portal and Sign In, Set it Active](ProSnippets-sharing#arcgisportalmanager-get-a-portal-and-sign-in-set-it-active)
}
Retrieve a project item from a portal and open it
var projectPortal = ArcGISPortalManager.Current.GetPortal(new Uri(@"https://<serverName>.<domain>.com/portal/", UriKind.Absolute));
string owner = string.Empty;
await QueuedTask.Run(() => {
//Get the signed on user name
owner = projectPortal.GetSignOnUsername();
});
//Get the user content from the portal
var userContent = await projectPortal.GetUserContentAsync(owner);
//Get the first portal project item
var firstPortalProject = userContent.PortalItems.FirstOrDefault(pi => pi.PortalItemType == PortalItemType.ProProject);
var portalProjectUri = firstPortalProject.ItemUri.ToString();
//Check if project can be opened
string docVer = string.Empty;
if (Project.CanOpen(portalProjectUri, out docVer))
{
await Project.OpenAsync(portalProjectUri);
}
//Note: If Project.CanOpen returns false, the project cannot be opened. One reason could be
// the active portal is not the same as the portal of the project. Refer to the snippet: [Workflow to open an ArcGIS Pro project](ProSnippets-sharing#workflow-to-open-an-arcgis-pro-project)
Requirements
Target Platforms: Windows 11, Windows 10
ArcGIS Pro version: 3.0 or higher.
See Also