getConfigDocCollection(String) Method

gets the documentation dictionary for the config dropdown (used by ConfigFiles.createConfigTreeMenu()). This is the basis for the documentation provided when clicking the config entries with Ctrl or Shift

Namespace: DBaddinAssembly: DBaddin in (DBaddin.dll)

Syntax

public static Dictionary<string, string> getConfigDocCollection(
	string ConfigDocQuery
	)

Parameters

ConfigDocQuery: Type: String
query against current active environment for retrieving the data for the documentation. This query needs to return three fields for each table/view/field object: 1. database of the object (only really needed for tables/views), 2. table/view name (for fields this is the parent table/view) and 3. the documentation for the object. All this has to be ordered by table/view name, with the table/view object being first

Returns

Dictionary<,>

a dictionary of table/view keys and their associated collected documentation of the table/view and its fields. This is being collected by assuming the ordered way the query returns the data (see above)