CRMContext
Definiert in: lib/CRMContext.ts:67
Stellt Objekte bereit die im aktuellen CRM Kontext zur Verfügung stehen.
Deprecated
Dieses SDK steht in Zukunft nicht mehr zur Verfügung und wurde durch combitCRM.SDK.WindowsClient bzw. combitCRM.SDK.Extended ersetzt
Implementiert
AsyncDisposable
Eigenschaften
ActiveView
Abfragesignatur
get ActiveView(): Promise<View>;
Definiert in: lib/CRMContext.ts:213
Gibt die aktuell aktive Ansicht View zurueck.
Example
const view = await cRM_Context.ActiveView;
Deprecated
Die Eigenschaft steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getActiveViewAsync ersetzt wurde.
Rückgabewert
Promise<View>
ActiveViews
Abfragesignatur
get ActiveViews(): Promise<ListViews>;
Definiert in: lib/CRMContext.ts:179
Gibt die aktiven geoeffneten Ansichten als Objekt vom Typ ListViews zurück
Deprecated
Die Eigenschaft steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getActiveViewsAsync ersetzt wurde.
Rückgabewert
Promise<ListViews>
cRM
Abfragesignatur
get cRM(): cRMApplication;
Definiert in: lib/CRMContext.ts:71
Rückgabewert
CurrentContainers
Abfragesignatur
get CurrentContainers(): Promise<ListContainers>;
Definiert in: lib/CRMContext.ts:370
Gibt die Container der aktuellen Eingabemaske zurück
Deprecated
Die Eigenschaft steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getCurrentContainersAsync ersetzt wurde.
Rückgabewert
Promise<ListContainers>
CurrentRecord
Abfragesignatur
get CurrentRecord(): Promise<Record>;
Definiert in: lib/CRMContext.ts:307
Gibt den Record des aktuell aktiven Datensatzes zurück.
Deprecated
Die Eigenschaft steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getCurrentRecordAsync ersetzt wurde.
Rückgabewert
Promise<Record>
CurrentRecordSet
Abfragesignatur
get CurrentRecordSet(): Promise<RecordSet>;
Definiert in: lib/CRMContext.ts:281
Gibt das RecordSet der aktuell aktiven Ansicht zurück.
Deprecated
Die Eigenschaft steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getCurrentRecordSetAsync ersetzt wurde.
Rückgabewert
Promise<RecordSet>
CurrentUser
Abfragesignatur
get CurrentUser(): Promise<string>;
Definiert in: lib/CRMContext.ts:128
Gibt den aktuellen Benutzernamen zurück
Deprecated
Die Eigenschaft steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getCurrentUserAsync ersetzt wurde.
Rückgabewert
Promise<string>
Project
Abfragesignatur
get Project(): Promise<Project>;
Definiert in: lib/CRMContext.ts:103
Gibt das geladene Projekt als Objekt vom Typ Project zurueck (leer, wenn kein Projekt geladen).
Example
const project = await cRM_Context.Project;
Deprecated
Die Eigenschaft steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getProjectAsync ersetzt wurde.
Rückgabewert
Promise<Project>
ProjectDir
Abfragesignatur
get ProjectDir(): Promise<string>;
Definiert in: lib/CRMContext.ts:153
Gibt das aktuelle Projektverzeichnis zurück
Deprecated
Die Eigenschaft steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getProjectDirAsync ersetzt wurde.
Rückgabewert
Promise<string>
ViewConfigs
Abfragesignatur
get ViewConfigs(): Promise<ListViewConfigs>;
Definiert in: lib/CRMContext.ts:428
Gibt das ListViewConfigs Objekt des aktuellen Projektes zurück.
Deprecated
Die Eigenschaft steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getViewConfigsAsync ersetzt wurde.
Rückgabewert
Promise<ListViewConfigs>
Konstruktoren
Konstruktor
new CRMContext(cRM): CRMContext;
Definiert in: lib/CRMContext.ts:76
Parameter
| Parameter | Type |
|---|---|
cRM | cRMApplication |
Rückgabewert
CRMContext
Methoden
[asyncDispose]()
asyncDispose: Promise<void>;
Definiert in: lib/CRMContext.ts:1131
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
CurrentInputForm()
CurrentInputForm(mode?): Promise<InputForm>;
Definiert in: lib/CRMContext.ts:351
Liefert die InputForm der offenen Ansicht.
Parameter
| Parameter | Type | Description |
|---|---|---|
mode? | InputFormMode | Der InputFormMode in dem die Ansicht gesetzt werden soll. Default: InputFormMode.KeepCurrentMode |
Rückgabewert
Promise<InputForm>
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getCurrentInputFormAsync ersetzt wurde.
disposeAsync()
disposeAsync(): Promise<void>;
Definiert in: lib/CRMContext.ts:885
Gibt alle von dieser Instanz verwendenten Objekte frei.
Rückgabewert
Promise<void>
DisposeAsync()
DisposeAsync(): Promise<void>;
Definiert in: lib/CRMContext.ts:910
Gibt alle von dieser Instanz verwendenten Objekte frei.
Rückgabewert
Promise<void>
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion disposeAsync ersetzt wurde.
ExecuteSqlProcedur()
ExecuteSqlProcedur(procedure, ...params): Promise<boolean>;
Definiert in: lib/CRMContext.ts:636
Parameter
| Parameter | Type |
|---|---|
procedure | string |
...params | ( | SqlParameterValue | SqlProcedureParameter)[] |
Rückgabewert
Promise<boolean>
Deprecated
executeSqlProcedureAsync verwenden
ExecuteSqlProcedure()
ExecuteSqlProcedure(procedure, ...params): Promise<boolean>;
Definiert in: lib/CRMContext.ts:643
Parameter
| Parameter | Type |
|---|---|
procedure | string |
...params | ( | SqlParameterValue | SqlProcedureParameter)[] |
Rückgabewert
Promise<boolean>
Deprecated
executeSqlProcedureAsync verwenden
executeSqlProcedureAsync()
executeSqlProcedureAsync(procedure, ...params): Promise<boolean>;
Definiert in: lib/CRMContext.ts:599
Führt die angebene Prozedur via sqlShell aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
procedure | string | Name der Prozedur |
...params | ( | SqlParameterValue | SqlProcedureParameter)[] | Parameter der Prozedur vom Typ SqlParameterValue oder SqlProcedureParameter |
Rückgabewert
Promise<boolean>
truewenn die Prozedur erfolgreich ausgeführt wurdefalsewenn es bei der Ausführung zu einem Fehler kam, die Fehler Informationen kann man dann über sqlShell.LastError erhalten.
Example
Beispiel 1: Standard
await cRMContext.executeSqlProcedureAsync("test", "Das ist ein Text.", true, false, 123, new Date(2023, 10, 9, 15, 20, 19)); //> Exec test 'Das ist ein Text.', 1, 0, 123, '20231009 15:20:19'
Beispiel 2: Array soll an die Funktion übergeben werden.
const args = ["Das ist ein Text.", true, false, 123, new Date(2023, 10, 9, 15, 20, 19)];
await cRMContext.executeSqlProcedureAsync("test", ...args); //> Exec test 'Das ist ein Text.', 1, 0, 123, '20231009 15:20:19'
Beispiel 3: Übergabe von benannten Parametern an eine Prozedur
await cRMContext.executeSqlProcedureAsync("test", {name: "@ParamName", value: "Das ist ein Text."}, {name: "test", value: true}); //> Exec test ＠ParamName = 'Das ist ein Text.', ＠test = 1
ExpandCRMPathVariable()
ExpandCRMPathVariable(path): Promise<string>;
Definiert in: lib/CRMContext.ts:937
Gibt den aufgelösten Pfad Ersetzungstexte wie z.B. %PRJDIR% zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
path | string | Pfad |
Rückgabewert
Promise<string>
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion expandCRMPathVariableAsync ersetzt wurde.
expandCRMPathVariableAsync()
expandCRMPathVariableAsync(path): Promise<string>;
Definiert in: lib/CRMContext.ts:918
Gibt den aufgelösten Pfad Ersetzungstexte wie z.B. %PRJDIR% zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
path | string | Pfad |
Rückgabewert
Promise<string>
getActiveViewAsync()
getActiveViewAsync(): Promise<View>;
Definiert in: lib/CRMContext.ts:200
Gibt die aktuell aktive Ansicht View zurueck.
Rückgabewert
Promise<View>
Example
const view = await cRM_Context.getActiveViewAsync();
getActiveViewsAsync()
getActiveViewsAsync(): Promise<ListViews>;
Definiert in: lib/CRMContext.ts:170
Gibt die aktiven geoeffneten Ansichten als Objekt vom Typ ListViews zurück
Rückgabewert
Promise<ListViews>
GetContainer()
GetContainer(containerName): Promise<Container>;
Definiert in: lib/CRMContext.ts:411
Gibt einen Container der aktiven Ansicht zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
containerName | string | Der Name des Containers |
Rückgabewert
Promise<Container>
Example
Das Container Objekt sollte nach der Verwendung freigeben werden.
const container = await cRM_Context.GetContainer('ID.FakturaBelege.Firmen_Recordid#{E7ACF3C9-7641-442B-9EF1-18BCFAC7A4B7}');
//...
await container.DisposeAsync();
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getContainerAsync ersetzt wurde.
getContainerAsync()
getContainerAsync(containerName): Promise<Container>;
Definiert in: lib/CRMContext.ts:394
Gibt einen Container der aktiven Ansicht zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
containerName | string | Der Name des Containers |
Rückgabewert
Promise<Container>
Example
Das Container Objekt sollte nach der Verwendung freigeben werden.
const container = await cRM_Context.getContainerAsync('ID.FakturaBelege.Firmen_Recordid#{E7ACF3C9-7641-442B-9EF1-18BCFAC7A4B7}');
//...
await container.DisposeAsync();
getCurrentContainersAsync()
getCurrentContainersAsync(): Promise<ListContainers>;
Definiert in: lib/CRMContext.ts:360
Gibt die Container der aktuellen Eingabemaske zurück
Rückgabewert
Promise<ListContainers>
getCurrentInputFormAsync()
getCurrentInputFormAsync(mode?): Promise<InputForm>;
Definiert in: lib/CRMContext.ts:326
Liefert die InputForm der offenen Ansicht.
Parameter
| Parameter | Type | Description |
|---|---|---|
mode? | InputFormMode | Der InputFormMode in dem die Ansicht gesetzt werden soll. Default: InputFormMode.KeepCurrentMode |
Rückgabewert
Promise<InputForm>
getCurrentRecordAsync()
getCurrentRecordAsync(): Promise<Record>;
Definiert in: lib/CRMContext.ts:297
Gibt den Record des aktuell aktiven Datensatzes zurück.
Rückgabewert
Promise<Record>
getCurrentRecordSetAsync()
getCurrentRecordSetAsync(): Promise<RecordSet>;
Definiert in: lib/CRMContext.ts:271
Gibt das RecordSet der aktuell aktiven Ansicht zurück.
Rückgabewert
Promise<RecordSet>
getCurrentUserAsync()
getCurrentUserAsync(): Promise<string>;
Definiert in: lib/CRMContext.ts:119
Gibt den aktuellen Benutzernamen zurück
Rückgabewert
Promise<string>
GetEmptyRecordSet()
GetEmptyRecordSet(viewName, cursorMode): Promise<RecordSet>;
Definiert in: lib/CRMContext.ts:542
Erzeugt ein leeres RecordSet für den übergebenen Ansichten-Namen.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
viewName | string | undefined | Name der Ansicht |
cursorMode | CRMCursorMode | CRMCursorMode.ForwardOnly | Default CRMCursorMode.ForwardOnly - CursorMode |
Rückgabewert
Promise<RecordSet>
Rückgabe: RecordSet wenn der Zugriff möglich ist, andernfalls null
Throws
Löst einen Fehler aus, wenn das ViewConfig-OBjekt nicht erzeugt werden konnte
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getEmptyRecordSetAsync ersetzt wurde.
getEmptyRecordSetAsync()
getEmptyRecordSetAsync(viewName, cursorMode): Promise<RecordSet>;
Definiert in: lib/CRMContext.ts:512
Erzeugt ein leeres RecordSet für den übergebenen Ansichten-Namen.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
viewName | string | undefined | Name der Ansicht |
cursorMode | CRMCursorMode | CRMCursorMode.ForwardOnly | Default CRMCursorMode.ForwardOnly - CursorMode |
Rückgabewert
Promise<RecordSet>
Rückgabe: RecordSet wenn der Zugriff möglich ist, andernfalls null
Throws
Löst einen Fehler aus, wenn das ViewConfig-OBjekt nicht erzeugt werden konnte
getEscapedSqlParameter()
getEscapedSqlParameter(param): string;
Definiert in: lib/CRMContext.ts:664
Funktion zum Wandeln von SqlParameterValue im Sql aktzeptierte Werte
-
String wird String.ToSqlString
-
Date wird Date.ToSqlString
Parameter
| Parameter | Type | Description |
|---|---|---|
param | SqlParameterValue | Wert |
Rückgabewert
string
Example
const result: string = cRMContext.getEscapedSqlParameter("Te'st") //=> 'Te''st'
const result: string = cRMContext.getEscapedSqlParameter(true) //=> 1
GetEscapedSqlParameter()
GetEscapedSqlParameter(param): string;
Definiert in: lib/CRMContext.ts:698
Funktion zum Wandeln von SqlParameterValue im Sql aktzeptierte Werte
-
String wird String.ToSqlString
-
Date wird Date.ToSqlString
Parameter
| Parameter | Type | Description |
|---|---|---|
param | SqlParameterValue | Wert |
Rückgabewert
string
Example
const result: string = cRMContext.GetEscapedSqlParameter("Te'st") //=> 'Te''st'
const result: string = cRMContext.GetEscapedSqlParameter(true) //=> 1
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getEscapedSqlParameter ersetzt wurde.
GetFieldValue()
GetFieldValue(
viewName,
filterType,
filter,
fieldName): Promise<string>;
Definiert in: lib/CRMContext.ts:826
Gibt den Inhalte des angeforderden Feldes für den ersten zurück gegeben Datensatz zurück, wurde kein Datensatz gefunden wird null zurück geben.
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
filterType | RecordSetFilterType | Filtertype |
filter | string | Filter |
fieldName | string | Feldname |
Rückgabewert
Promise<string>
Example
const result : string = await cRM_Context.GetFieldValue("FakturaWährungen", RecordSetFilterType.SetFilterDirectSQL, "SELECT Recordid FROM Factura_Waehrungen WHERE Standard = 1", 'ID');
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getFieldValueAsync ersetzt wurde.
getFieldValueAsync()
getFieldValueAsync(
viewName,
filterType,
filter,
fieldName): Promise<string>;
Definiert in: lib/CRMContext.ts:785
Gibt den Inhalte des angeforderden Feldes für den ersten zurück gegeben Datensatz zurück, wurde kein Datensatz gefunden wird null zurück geben.
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
filterType | RecordSetFilterType | Filtertype |
filter | string | Filter |
fieldName | string | Feldname |
Rückgabewert
Promise<string>
Example
const result : string = await cRM_Context.getFieldValueAsync("FakturaWährungen", RecordSetFilterType.SetFilterDirectSQL, "SELECT Recordid FROM Factura_Waehrungen WHERE Standard = 1", 'ID');
GetFieldValues()
GetFieldValues(
viewName,
filterType,
filter, ...
fields): Promise<IDictionary<string>>;
Definiert in: lib/CRMContext.ts:769
Gibt die Inhalte der angeforderden Felder für den ersten zurück gegeben Datensatz zurück, wurde kein Datensatz gefunden wird null zurück geben.
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
filterType | RecordSetFilterType | Filtertyp |
filter | string | Filtercontext |
...fields | string[] | Felder |
Rückgabewert
Promise<IDictionary<string>>
Throws
> Error - Wenn der Filter micht ausgeführt werden konnte.
Example
const result : IDictionary<string> = await cRM_Context.GetFieldValues('Firmen', RecordSetFilterType.SetFilterByPrimaryKey, '00b32d845e35c548b0b457d8dcc16b3d', 'Company', 'Company2', 'Company3');
result['Company'];
result['Company2'];
result['Company3'];
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getFieldValuesAsync ersetzt wurde.
getFieldValuesAsync()
getFieldValuesAsync(
viewName,
filterType,
filter, ...
fields): Promise<IDictionary<string>>;
Definiert in: lib/CRMContext.ts:718
Gibt die Inhalte der angeforderden Felder für den ersten zurück gegeben Datensatz zurück, wurde kein Datensatz gefunden wird null zurück geben.
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
filterType | RecordSetFilterType | Filtertyp |
filter | string | Filtercontext |
...fields | string[] | Felder |
Rückgabewert
Promise<IDictionary<string>>
Throws
> Error - Wenn der Filter micht ausgeführt werden konnte.
Example
const result : IDictionary<string> = await cRM_Context.getFieldValuesAsync('Firmen', RecordSetFilterType.SetFilterByPrimaryKey, '00b32d845e35c548b0b457d8dcc16b3d', 'Company', 'Company2', 'Company3');
result['Company'];
result['Company2'];
result['Company3'];
GetFullRecordSet()
GetFullRecordSet(
viewName,
sortOrder,
cursorMode): Promise<RecordSet>;
Definiert in: lib/CRMContext.ts:571
Erzeugt ein RecordSet mit allen Datensätzen für die Ansicht.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
viewName | string | undefined | Name der Ansicht |
sortOrder | number | 0 | Default 0 - Sortierung |
cursorMode | CRMCursorMode | CRMCursorMode.SolutionDefault | Default CRMCursorMode.SolutionDefault - CursorMode |
Rückgabewert
Promise<RecordSet>
Throws
Löst einen Fehler aus, wenn das ViewConfig-OBjekt nicht erzeugt werden konnte
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getFullRecordSetAsync ersetzt wurde.
getFullRecordSetAsync()
getFullRecordSetAsync(
viewName,
sortOrder,
cursorMode): Promise<RecordSet>;
Definiert in: lib/CRMContext.ts:553
Erzeugt ein RecordSet mit allen Datensätzen für die Ansicht.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
viewName | string | undefined | Name der Ansicht |
sortOrder | number | 0 | Default 0 - Sortierung |
cursorMode | CRMCursorMode | CRMCursorMode.SolutionDefault | Default CRMCursorMode.SolutionDefault - CursorMode |
Rückgabewert
Promise<RecordSet>
Throws
Löst einen Fehler aus, wenn das ViewConfig-OBjekt nicht erzeugt werden konnte
GetGlobalPropertySafe()
GetGlobalPropertySafe(propertyName, defaultValue): Promise<string>;
Definiert in: lib/CRMContext.ts:1069
Gibt den Inhalt eines Globalen Parameters zurück.
Hierbei wird die Maximallänge eines Parameters beachtet in dem die Abfrage automatisch sofern notwendig mehrere Parameternamen mit dem Schema Parameter, Parameter_2, usw. überprüft.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
propertyName | string | undefined | Name des Parameters |
defaultValue | string | null | Der Standartwert der Einstellung, welcher zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert |
Rückgabewert
Promise<string>
Example
const paramValue : string = await cRM_Context.GetGlobalPropertySafe('Parameter','Standardwert');
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getGlobalPropertySafeAsync ersetzt wurde.
getGlobalPropertySafeAsync()
getGlobalPropertySafeAsync(propertyName, defaultValue): Promise<string>;
Definiert in: lib/CRMContext.ts:1025
Gibt den Inhalt eines Globalen Parameters zurück.
Hierbei wird die Maximallänge eines Parameters beachtet in dem die Abfrage automatisch sofern notwendig mehrere Parameternamen mit dem Schema Parameter, Parameter_2, usw. überprüft.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
propertyName | string | undefined | Name des Parameters |
defaultValue | string | null | Der Standartwert der Einstellung, welcher zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert |
Rückgabewert
Promise<string>
Example
const paramValue : string = await cRM_Context.getGlobalPropertySafeAsync('Parameter','Standardwert');
getProjectAsync()
getProjectAsync(): Promise<Project>;
Definiert in: lib/CRMContext.ts:90
Gibt das geladene Projekt als Objekt vom Typ Project zurueck (leer, wenn kein Projekt geladen).
Rückgabewert
Promise<Project>
Example
const project = await cRM_Context.project;
getProjectDirAsync()
getProjectDirAsync(): Promise<string>;
Definiert in: lib/CRMContext.ts:144
Gibt das aktuelle Projektverzeichnis zurück
Rückgabewert
Promise<string>
GetRecordSet()
GetRecordSet(
viewName,
filterType,
filter,
sortOrder,
cursorMode): Promise<RecordSet>;
Definiert in: lib/CRMContext.ts:501
Erzeugt ein Objekt vom Typ RecordSet für den übergebenen Ansichten bei Name.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
viewName | string | undefined | Name der Ansicht |
filterType | RecordSetFilterType | undefined | Filtertyp |
filter | string | undefined | Filtercontext |
sortOrder | number | 0 | - |
cursorMode | CRMCursorMode | CRMCursorMode.SolutionDefault | - |
Rückgabewert
Promise<RecordSet>
Rückgabe: RecordSet wenn der Zugriff möglich ist, andernfalls null
Throws
Löst einen Fehler aus, wenn das ViewConfig-OBjekt nicht erzeugt werden konnte
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getRecordSetAsync ersetzt wurde.
getRecordSetAsync()
getRecordSetAsync(
viewName,
filterType,
filter,
sortOrder,
cursorMode): Promise<RecordSet>;
Definiert in: lib/CRMContext.ts:482
Erzeugt ein Objekt vom Typ RecordSet für den übergebenen Ansichten bei Name.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
viewName | string | undefined | Name der Ansicht |
filterType | RecordSetFilterType | undefined | Filtertyp |
filter | string | undefined | Filtercontext |
sortOrder | number | 0 | - |
cursorMode | CRMCursorMode | CRMCursorMode.SolutionDefault | - |
Rückgabewert
Promise<RecordSet>
Rückgabe: RecordSet wenn der Zugriff möglich ist, andernfalls null
Throws
Löst einen Fehler aus, wenn das ViewConfig-OBjekt nicht erzeugt werden konnte
GetViewConfigByName()
GetViewConfigByName(viewName): Promise<ViewConfig>;
Definiert in: lib/CRMContext.ts:470
Liefert eine Ansicht mit dem übergebenen Namen als Objekt zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
Rückgabewert
Promise<ViewConfig>
Rückgabe: ViewConfig wenn der Zugriff möglich ist, andernfalls null
Example
Das ViewConfig Objekt sollte nach der Verwendung freigeben werden.
const viewConfig = await cRM_Context.GetViewConfigByName('FakturaBelege');
//...
await viewConfig.DisposeAsync();
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion getViewConfigByNameAsync ersetzt wurde.
getViewConfigByNameAsync()
getViewConfigByNameAsync(viewName): Promise<ViewConfig>;
Definiert in: lib/CRMContext.ts:452
Liefert eine Ansicht mit dem übergebenen Namen als Objekt zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
Rückgabewert
Promise<ViewConfig>
Rückgabe: ViewConfig wenn der Zugriff möglich ist, andernfalls null
Example
Das ViewConfig Objekt sollte nach der Verwendung freigeben werden.
const viewConfig = await cRM_Context.getViewConfigByNameAsync('FakturaBelege');
//...
await viewConfig.DisposeAsync();
getViewConfigsAsync()
getViewConfigsAsync(): Promise<ListViewConfigs>;
Definiert in: lib/CRMContext.ts:419
Gibt das ListViewConfigs Objekt des aktuellen Projektes zurück.
Rückgabewert
Promise<ListViewConfigs>
HasActiveView()
HasActiveView(): Promise<boolean>;
Definiert in: lib/CRMContext.ts:236
Gibt an, ob eine Aktive Ansicht vorhanden ist
Rückgabewert
Promise<boolean>
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion hasActiveViewAsync ersetzt wurde.
hasActiveViewAsync()
hasActiveViewAsync(): Promise<boolean>;
Definiert in: lib/CRMContext.ts:228
Gibt an, ob eine Aktive Ansicht vorhanden ist
Rückgabewert
Promise<boolean>
IsActiveView()
IsActiveView(name): Promise<boolean>;
Definiert in: lib/CRMContext.ts:262
Prueft ob die Aktive Ansicht den Namen
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name der Ansicht |
Rückgabewert
Promise<boolean>
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion isActiveViewAsync ersetzt wurde.
isActiveViewAsync()
isActiveViewAsync(name): Promise<boolean>;
Definiert in: lib/CRMContext.ts:245
Prueft ob die Aktive Ansicht den Namen
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name der Ansicht |
Rückgabewert
Promise<boolean>
OpenFilteredView()
OpenFilteredView(
targetViewName,
filterType,
filterContent,
forceNewView?): Promise<void>;
Definiert in: lib/CRMContext.ts:1006
Öffnet eine Ansicht mit dem übergebnen Filter, als aktive Ansicht im combit CRM.
Parameter
| Parameter | Type | Description |
|---|---|---|
targetViewName | string | Name der zu öffnenden Ansicht |
filterType | RecordSetFilterType | Filtertyp |
filterContent | string | Filter |
forceNewView? | boolean | Gibt an ob in jedem Fall eine neue Ansicht geöffnet werden soll. Default: false |
Rückgabewert
Promise<void>
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion openFilteredViewAsync ersetzt wurde.
openFilteredViewAsync()
openFilteredViewAsync(
targetViewName,
filterType,
filterContent,
forceNewView?): Promise<void>;
Definiert in: lib/CRMContext.ts:971
Öffnet eine Ansicht mit dem übergebnen Filter als aktive Ansicht im combit CRM. Der CRMContext wird hierbei zurückgesetzt
Parameter
| Parameter | Type | Description |
|---|---|---|
targetViewName | string | Name der zu öffnenden Ansicht |
filterType | RecordSetFilterType | Filtertyp |
filterContent | string | Filter |
forceNewView? | boolean | Gibt an ob in jedem Fall eine neue Ansicht geöffnet werden soll. Default: false |
Rückgabewert
Promise<void>
Throws
Löst einen Fehler aus, wenn die Ansicht nicht geöffnet werden konnte.
RefreshContext()
RefreshContext(): Promise<void>;
Definiert in: lib/CRMContext.ts:850
Gibt den aktuell geladenen Context wieder frei.
Rückgabewert
Promise<void>
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion refreshContextAsync ersetzt wurde.
refreshContextAsync()
refreshContextAsync(): Promise<void>;
Definiert in: lib/CRMContext.ts:842
Gibt den aktuell geladenen Context wieder frei.
Rückgabewert
Promise<void>
SetGlobalPropertySafe()
SetGlobalPropertySafe(propertyName, value): Promise<void>;
Definiert in: lib/CRMContext.ts:1127
Setzt den Inhalt eines Globalen Parameters.
Hierbei wird die Maximallänge eines Parameters beachtet in dem die Abfrage automatisch sofern notwendig den Wert auf mehrere Parameternamen mit dem Schema Parameter, Parameter_2, usw. aufteilt.
Parameter
| Parameter | Type | Description |
|---|---|---|
propertyName | string | Name des Parameters |
value | string | Wert des Parameters |
Rückgabewert
Promise<void>
Example
await cRM_Context.SetGlobalPropertySafe('Parameter','Wert');
Deprecated
Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion setGlobalPropertySafeAsync ersetzt wurde.
setGlobalPropertySafeAsync()
setGlobalPropertySafeAsync(propertyName, value): Promise<void>;
Definiert in: lib/CRMContext.ts:1085
Setzt den Inhalt eines Globalen Parameters.
Hierbei wird die Maximallänge eines Parameters beachtet in dem die Abfrage automatisch sofern notwendig den Wert auf mehrere Parameternamen mit dem Schema Parameter, Parameter_2, usw. aufteilt.
Parameter
| Parameter | Type | Description |
|---|---|---|
propertyName | string | Name des Parameters |
value | string | Wert des Parameters |
Rückgabewert
Promise<void>
Example
await cRM_Context.setGlobalPropertySafeAsync('Parameter','Wert');
shrinkCRMPathVariableAsync()
shrinkCRMPathVariableAsync(path): Promise<string>;
Definiert in: lib/CRMContext.ts:945
Gibt den Pfad verkürzt durch Ersetzungstexte wie z.B. %PRJDIR% zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
path | string | Pfad |
Rückgabewert
Promise<string>