ArcObjects Library Reference  (EditorExt)    

ArcPadExtension CoClass

The ArcPad Tools Extension.

Not all instances of ArcPadExtension support IExtension, IArcPadExtension, IArcPadDefaults, or IArcPadDefaultsEdit. Check if the object reference is of the appropriate object type using the TypeOf operator before using QI with these interfaces.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Extended Error Information

Use the ISupportErrorInfo method InterfaceSupportsErrorInfo to determine if the object supports extended error information. If the object supports extended error info, VC++ developers should use the OLE/COM IErrorInfo interface to access the ErrorInfo object. Visual Basic developers should use the global error object Err to retrieve this extended error information.

Interfaces

Interfaces Description
IArcPadDefaults Provides access to the ArcPad Default Settings.
IArcPadDefaultsEdit Provides access to the ArcPad Default Settings.
IArcPadExtension Provides access to the ArcPad Extension.
IArcPadTransaction Provides access to the ArcPad transaction methods.
IExtension (esriSystem) Provides access to members that define an extension.
ISupportErrorInfo Indicates whether a specific interface can return Automation error objects.

Remarks

The ArcPadExtension object represents the ArcPad extension to ArcMap - it is the main component and the focal point for all other objects in the ArcPad object model.  Although the ArcPadExtension object is cocreateable, it is automatically created whenever a new ArcMap session starts; in fact, all ArcMap extension objects are automatically instantiated when ArcMap is first started.
The ArcPadExtension object is used to provide an environment for integration between ArcPad and ArcMap. Use the ArcPadExtension object to control the default settings of the Get Data For ArcPad wizard, to access the APTransLog object, or to Copyout, Checkout, or Checkin data from ArcPad programmatically.
To get a reference to the ArcPad extension, use IApplication::FindExtensionByCLSID .
The ArcPad extension manages the APTransLog object. A reference to this object is provided by IArcPadExtension::Log.
[C#]

The following C# code example illustrates how to acquire a reference of IArcPadExtension to the ArcPadExtension object.

public void GetArcPadExtensionByCLSID()
{
  UID extUid = new UIDClass();
  extUid.Value = "editorExt.ArcPadExtension";
  //You can get app from ICommand :: OnCreate() hook parameter
  IArcPadExtension arcpadExt = app.FindExtensionByCLSID(extUid) as IArcPadExtension;
}
[Visual Basic 6.0]

The following VBA code example illustrates how to acquire a reference of type IArcPadExtension to the ArcPadExtension object.

 Sub GetArcPadExtensionByCLSID()
   Dim pArcPadExtension As IArcPadExtension
Dim pID As New UID pID = "editorExt.ArcPadExtension" Set pArcPadExtension = Application.FindExtensionByCLSID(pID) End Sub
[Visual Basic .NET]

The following VBNet code example illustrates how to acquire a reference of IArcPadExtension to the ArcPadExtension object.

  Public Sub GetArcPadExtensionByCLSID()
    'You can get app from ICommand :: OnCreate() hook parameter
    Dim extUid As UID = New UIDClass()
    extUid.Value = "editorExt.ArcPadExtension"
    Dim arcpadExt As IArcPadExtension = TryCast(app.FindExtensionByCLSID(editorUid), IArcPadExtension)
  End Sub


 

ArcPadExtension consists of the following: ArcPadExtension.