|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICustomizationFilter
Provides access to members that define a customization filter.
A customization filter provides a mechanism to lock parts of the customization functionality in the ArcGIS applications. You should only use customization filters in locked down applications where you have complete control of the application setup and how the users interact with that application.
To activate your customization filter you would pass it into the IApplication::LockCustomization method. You can make the call to LockCustomization in a simple VBA macro, in the MxDocument_OpenDocument or MxDocument_NewDocument event in VBA, or in an extension. If this is done in a macro or the open document event in VBA, make sure that the VBA project has a reference the class that implements the customization filter.
If the customization filter is applied in an extension, you must be aware of the application start up sequence in order for this to work correctly. Also be aware that your customization filter applied by an extension may override other locking logic that might be saved in an existing ArcMap document or that another extension might activate a customization filter before your extension is even loaded. There can only be one active customization filter in a running application.
To create a custom customization filter you would implement the ICustomizationFilter interface in a class module. The ICustomizationFilter interface has an OnCustomizationEvent event that gets fired whenever a user attempts any type of customization.
IApplication.lockCustomization(String, com.esri.arcgis.framework.ICustomizationFilter)
Method Summary | |
---|---|
boolean |
onCustomizationEvent(int custEventType,
Object eventCtx)
Occurs when certain types of customization occur. |
Method Detail |
---|
boolean onCustomizationEvent(int custEventType, Object eventCtx) throws IOException, AutomationException
In the Customize dialog, Macros, Menus, New Menus, and UIControls are four special categories that are formatted with the square bracket ([]) to indicate they are associated with special functionalities.
However, the eventCtx parameter always supplies the unformatted category name for custEventType esriCEAddCategory even though they are enclosed in square brackets in the Customize dialog.
custEventType
- A com.esri.arcgis.framework.esriCustomizationEvent constant (in)eventCtx
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IApplication.lockCustomization(String, com.esri.arcgis.framework.ICustomizationFilter)
,
esriCustomizationEvent
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |