Inhalt | ||
---|---|---|
|
Introduction
...
Info | ||
---|---|---|
| ||
Congree knows about the editor type. Currently, the following types of editors can be passed as parameter of CreateControlContext:The Congree API for XMetaL XMAX, Congree API for XMetaL© XMAX and Proxy Editor .Manual |
Congree also provides a standard Congree toolbar which has its own ID and can be also embedded in AxPlaceHolderControl.
...
Initialize the Congree application. You should call this method after creating the ICongreeBootstrapper. Use thirdPartySystemIdentifier parameter if it is necessary to initialize Congree with predefined third-party system identifier.
Parameters
BSTR thirdPartySystemIdentifier -
Remark: The thirdPartySystemIdentifier can be empty
...
VARIANT control - The COM object that defines the editor. E.g it can be specific ActiveX control or other well known for Congree COM object which provides access to the editor.
VARIANT placeHolders - The collection of AxPlaceHolderControl controls. The argument can be either collection (SAFEARRAY) of AxPlaceHolderControl or certain AxPlaceHolderControl ActiveX control.
Remark: Each placeholder is used by Congree as the container to place inside the specific Congree panel (e.g. Terminology Research Panel). The placeholder is the ActiveX object, which is installed with Congree and registered in the operating system. Thus, for example, if you are using WinForms, you can simply open the list of ActiveX components and drag the AxPlaceHolderControl to the form. For each Congree panel you want to use in your application, you need to create an AxPlaceHolderControl.
Returns
The instance of IControlContext.
Properties
PanelInfos
Returns
...
Returns the instance of IAuthorizationManager.
IControlContext
The instance of IControlContext is responsible for binding external editor (control) with Congree placeholders (AxPlaceHolderControl).
...
Adds new placeholders to the control context. With this method you can dynamically add some Congree panels.
Parameters
VARIANT placeHolders - The collection of AxPlaceHolderControl controls.
Remark: This can be useful in the following scenario:
...
Releases the certain placeholder from the control context.
Parameters
VARIANT placeHolders - The collection of AxPlaceHolderControl controls.
Remark: You should use this method to release the placeholder from the certain context when, e.g., user closes some window which contains the placeholder.
...
Fig.3. Congree Authoring Client placeholders are shared between different control contexts.
IPanelInfo
Provides information about Congree panels. Congree is modular application and consists of many modules (extensions). Each module implements its own collection (one or more) of Congree panel (e.g. Language Check Panel, Authoring Memory Panel, Terminology Research Panel and so on).
...
Returns the check report. The report is XML based document.
Parameters
BSTR modules - a list of modules for which a report is required. The list of modules must be listed via ";". The allowed list of names you can find in the this table
Name of module | Description |
---|---|
Linguistic | Represents the Congree Language check module |
Returns
Returns the XML document as string which contains the report.
...
The list of possible values can be found in Table 1.
Table 1
Control ID (ClientID) | Module which exposes this control | Description |
---|---|---|
Congree.GenericToolbar | Congree | The Congree toolbar. (see Fig.1. |
Congree.AuthoringMemory.Panel | Authoring Memory | The Authoring Memory Panel |
Congree.AuthoringMemory.Preview.Panel | Authoring Memory | The Authoring Memory Preview Panel |
Congree.AuthoringMemoryCandidates.Panel | Authoring Memory Candidates | The Authoring Memory Candidates Panel |
Congree.Reporting.Panel | Authoring Memory | The Authoring Memory Report Panel |
Congree.Linguistic.Panel | Linguistic | The Language Check Panel |
Congree.Terminology.Panel | Terminology | The Terminology Research Panel |
Congree.TerminologyCandidates.Panel | Terminology Candidates | The Term Candidates Panel |
Congree.AuthoringMemoryNonNative.Panel | Authoring Memory Non Native | The Non-native authoring Panel |
Table 1 contains the list of IDs of the Congree panels which are implemented by different modules of the Congree Authoring Client. If some module is disabled (via Extensions in the Congree Authoring Client settings), the corresponding Congree panel will not be loaded and, therefore, will not be displayed even though the placeholder for this Congree panel exists.
...
Remark: Congree provides the UserNamePasswordClientCredentialComShim co-class which implements IUserNamePasswordClientCredential interface and internally is Inherited from IClientCredentials.
...