GXARCDH class

class GXARCDH(handle=0)[source]

GXARCDH class.

This library is not a class. It contains various utilities used in the Target extension for ArcGIS.

__init__(handle=0)[source]
classmethod close_project()[source]

Closes the current GXDH project in the Target extension

New in version 8.0.

License: Geosoft Extended End-User License

classmethod geostrings_extension_available()[source]

Verifies if the geostrings extension in TfA is available. Return 1 if true, 0 otherwise

Return type:

int

New in version 8.0.1.

License: Geosoft Extended End-User License

classmethod get_current_string_file_gdb(name)[source]

Gets the current Geostring File Geodatabase.

Parameters:

name (str_ref) – Name returned

New in version 8.0.1.

License: Geosoft Extended End-User License

classmethod has_string_file_gdb_edits()[source]

Is a Geostring File Geodatabase loaded and contains edits?

Return type:

int

New in version 8.0.1.

License: Geosoft Extended End-User License

is_null()[source]

Check if this is a null (undefined) instance

Returns:

True if this is a null (undefined) instance, False otherwise.

Return type:

bool

classmethod is_valid_feature_class_name(feature_class_name)[source]

Is this a valid featureclass name?

Parameters:

feature_class_name (str) – Featureclass name

Return type:

int

New in version 8.0.1.

License: Geosoft Extended End-User License

classmethod is_valid_fgdb_file_name(fgdb)[source]

Is this a valid FGDB filename?

Parameters:

fgdb (str) – FGDB filename

Return type:

int

New in version 8.0.1.

License: Geosoft Extended End-User License

classmethod null()[source]

A null (undefined) instance of GXARCDH

Returns:

A null GXARCDH

Return type:

GXARCDH

classmethod s_prompt_for_esri_symbol(hwnd, h_wnd, input_xml_string, xml, fill_color, edge_color)[source]

Prompt the user to select an ESRI symbol and return it as an XML string. The output string will be empty if the user cancels the dialog.

Parameters:

  • hwnd (int) – Window handle

  • h_wnd (str) – Initial symbol that you want displayed when the dialog is launched (use “” if none)

  • input_xml_string (int) – (This parameter is ignored if an initial symbol was specified) Initial symbol type that you want displayed when the dialog is launched (0 for Fill, 1 for Line)

  • xml (str_ref) – Returned XML string representing the symbol that was chosen by the user

  • fill_color (int_ref) – RGBA representation of fill color to be set

  • edge_color (int_ref) – RGBA representation of edge color to be set

New in version 8.2.

License: Geosoft Extended End-User License

classmethod set_project(path, project)[source]

Sets the current GXDH project in the Target extension

Parameters:

  • path (str) – Path String

  • project (str) – Project Name

New in version 8.0.

License: Geosoft Extended End-User License

classmethod set_string_file_gdb(string_file_gdb)[source]

Sets the current Geostring File Geodatabase in the Target extension

Parameters:

string_file_gdb (str) – File Geodatabase

New in version 8.0.

License: Geosoft Extended End-User License

classmethod stop_editing_string_file_gdb()[source]

Stops editing session for current string fGDB

New in version 8.0.1.

License: Geosoft Extended End-User License