 |
This document is archived and information here might be outdated. Recommended version. |
IARControl.ARConfiguration Property (ArcObjects .NET 10.8 SDK)
|
This document is archived and information here might be outdated. Recommended version. |
The ARConfiguration used by the control.
[Visual Basic .NET] Public Property ARConfiguration As ArcReaderConfiguration
[C#] public ArcReaderConfiguration ARConfiguration {get; set;}
This is the ARConfiguration object contained within the ArcReaderControl. It is a helper object for customising the appearance and behaviour of the ArcReaderControl. It consists of many property and value settings that are stored in a template file (.art), known as an ‘ArcReader Template’.
There are various ways to manage these property and value settings:
In order for the ArcReaderControl to update itself to match any updated settings the ARConfiguration object must be set back into the ArcReaderControl.
The ArcReaderControl will initially look for an template file in a users local profile. If no template file is found a default configuration file will be created containing default settings. The contents of the ARConfiguration can be stored in a template file in the current user profile and used as an initialization or "INI" file. The ArcReader desktop application does this using a
file called ArcReader.art. It is recommended not to reuse this file as it may break the ArcReader desktop application. Instead, use a location such as:
User profile\Application Data\CompanyName\ProductName\Templates\FileName.art
Once a template has been saved it can be loaded into the ArcReaderControl to suit a particular user or application. For example, a user may have a preference about the window position of the magnifier window and whether the table of contents is displayed. When the ArcReaderControl exits (typically when the form or container is closed) the value of these setting is updated back into the ARConfiguration. Additional custom settings can be added to the ARConfiguration, to store user preferences specific to the custom application.