This document is archived and information here might be outdated.  Recommended version.


IARControl.HasDocumentPermission Method (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > PublisherControls > ESRI.ArcGIS.PublisherControls > Interfaces > IA > IARControl Interface > IARControl.HasDocumentPermission Method
ArcGIS Developer Help

IARControl.HasDocumentPermission Method

Indicates if the currently loaded Published Map File (*.PMF) was published with the specified permission.

[Visual Basic .NET]
Public Function HasDocumentPermission ( _
    ByVal docPermission As esriARDocumentPermissions _
) As Boolean

[C#]
public bool HasDocumentPermission (
    esriARDocumentPermissions docPermission
);

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Description

The HasDocumentPermission method determines whether the currently loaded document was published with the specified functionality permission.

When a document is published the publisher can set a variety of permissions to limit the functionality that a user has access to when viewing the document in the ArcReaderControl. These permissions should be checked and the behaviour of an application modified appropriately. For example, if permission to access hyperlinks does not exist an application should be modified so that a user can not set the current tool to the hyperlink tool.

Errors Returned

2003 800A07D3: No document loaded

2014 800A07DE: The specified document permission is invalid 

Remarks

esriARDocumentPermissionsPrint: Indicates whether permission exists to use the PrintView method and the ShowARWindow  method to open the PageSetup and Printer windows.

esriARDocumentPermissionsExport: Indicates whether permission exists to use the IARControl::ExportView method.

esriARDocumentPermissionsIdentify: Indicates whether permission exists to set the CurrentARTool property to the Identify tool to use the ShowARWindow method to open the Identify window.

esriARDocumentPermissionsFind: Indicates whether permission exists to use the  ShowARWindow method to open the Find window.

esriARDocumentPermissionsChangeView: Indicates whether permission exists to set the CurrentView property.

esriARDocumentPermissionsChangeLayerVisibility: Indicates whether permission exists to set the IARLayer::Visible property.

esriARDocumentPermissionsHyperlink: Indicates whether permission exists to set the CurrentARTool property to the Hyperlinks tool.

esriARDocumentPermissionsMeasure: Indicates whether permission exists to set the CurrentARTool property to the Measure tool.

esriARDocumentPermissionsViewTOC: Indicates whether permission exists to set the TOCVisible property.

esriARDocumentPermissionsOnlyInArcReader: Indicates whether permission exists for Published Map File to be loaded into the ArcReaderControl.

esriARDocumentPermissionsQueryFeatures: Indicates whether permission exists to use the IARMap::SearchARFeatures, IARMap::QueryARFeatures,  IARLayer::SearchARFeatures, and IARLayer::QueryARFeatures methods.

esriARDocumentPermissionsQueryValues: Indicates whether permission exists to use the IARFeature::Value property.

esriARDocumentPermissionsCopyViewToClipboard: Indicates whether permission exists to use the CopyViewToClipboard method.

esriARDocumentPermissionsInternalObjects: Indicates whether permission exists to get the IARPageLayout::InternalObject, IARMap::InternalObject, IARLayer::InternalObject and IARFeature::InternalObject properties. This permission is true if the publisher selected "Unrestriced access to contents of Published Map" at the time of publishing.

See Also

IARControl Interface