Zum Hauptinhalt springen
Version: 25.143.1202.1

Record

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8481

Datensatz

Implementiert

  • AsyncDisposable
  • Disposable

Eigenschaften

Deletable

Abfragesignatur

get Deletable(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8495

Über diese Eigenschaft kann geprüft werden, ob ein Datensatz aufgrund von Datensatzrechten löschbar wäre.

Rückgabewert

boolean


Editable

Abfragesignatur

get Editable(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8504

Über diese Eigenschaft kann geprüft werden, ob ein Datensatz aufgrund von Datensatzrechten bearbeitbar wäre.

Rückgabewert

boolean


IsDisposed

Abfragesignatur

get IsDisposed(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8510

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:9010

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

[dispose]()

dispose: void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:9021

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

AddToBlacklist()

AddToBlacklist(fieldName): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8536

Nimmt den Inhalt des übergebenen Feldes in die Sperrliste auf. Dabei wird die zugehörige Auto-Protokoll Aktion "In Sperrliste aufnehmen" ausgelöst.

Parameter

ParameterTypeDescription
fieldNamestringFeldname, dessen Inhalt in die Sperrliste aufgenommen werden soll.

Rückgabewert

boolean

false wenn der Inhalt nicht in die Sperrliste aufgenommen werden konnte weil z.B. der interne Feldtyp nicht unterstützt wird, andernfalls true


AddToFavorites()

AddToFavorites(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8545

Fügt den aktuellen Datensatz den Favoriten hinzu.

Rückgabewert

boolean


AddToHistory()

AddToHistory(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8554

Fügt den aktuellen Datensatz dem Verlauf hinzu.

Rückgabewert

boolean


AddToPhoneManager()

AddToPhoneManager(fieldName): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8564

Fügt den aktuellen Datensatz dem phone manager hinzu.

Parameter

ParameterTypeDescription
fieldNamestringFeldname mit der Nummer, die hinzugefügt werden soll.

Rückgabewert

boolean


Delete()

Delete(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8573

Löscht einen Datensatz.

Rückgabewert

boolean


DialNumber()

DialNumber(fieldName): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8583

Wählt die übergebene Telefonnummer und entspricht insofern der manuellen Wahl.

Parameter

ParameterTypeDescription
fieldNamestringFeldname mit der zu wählenden Nummer

Rückgabewert

boolean


Dispose()

Dispose(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:9015

Standardimplementierung des Dispose

Rückgabewert

void


DisposeAsync()

DisposeAsync(): Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:9004

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>


GetContentsByFormula()

GetContentsByFormula(formula): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8595

Liefert das Ergebnis einer Formel auf Basis des aktuellen Datensatzes zurück. Die Felder des Datensatzes stehen dabei als Variablen zur Verfügung.

Parameter

ParameterTypeDescription
formulastringAuszuwertende Formel.

Rückgabewert

string

Inhalt des Feldes oder '' (Leere Zeichenfolge) wenn das Feld nicht vorhanden ist


GetContentsByName()

GetContentsByName(name): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8607

Liefert den Inhalt des Feldes als Zeichenkette zurück, dessen physikalischer Feldname übergeben wurde.

Parameter

ParameterTypeDescription
namestringPhysikalischer Name des gewünschten Feldes.

Rückgabewert

string

Inhalt des Feldes oder '' (Leere Zeichenfolge) wenn das Feld nicht vorhanden ist


GetContentsByNameToFile()

GetContentsByNameToFile(name, file): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8618

Das angegebene BLOB-Feld wird ausgelesen und dessen Inhalt unter dem angegebenen Dateinamen gespeichert.

Parameter

ParameterTypeDescription
namestringPhysikalischer Name des gewünschten (BLOB)-Feldes
filestringSpeicherpfad der angelegten Datei.

Rückgabewert

boolean


GetContentsValueByFormula()

GetContentsValueByFormula(formula): unknown;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8636

Liefert das Ergebnis einer Formel auf Basis des aktuellen Datensatzes entsprechend des zurückgelieferten Datentyps der Formel zurück.Die Felder des Datensatzes stehen dabei als Variablen zur Verfügung.

Parameter

ParameterTypeDescription
formulastringAuszuwertende Formel.

Rückgabewert

unknown

Inhalt des Feldes oder null wenn die Formel ungültig ist

Example

const text = record.GetContentsValueByFormula("Email: <eMail>");


GetContentsValueByName()

GetContentsValueByName(fieldName): unknown;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8653

Liefert den Inhalt entsprechend des Feldtyps des Feldes zurück, dessen Feldname übergeben wurde, z.B. Datumzeit-Typen als Datumsvariable, numerische Typen als numerische Variable etc.Somit werden bspw. Lokalisierungsprobleme (Komma oder Punkt als Dezimalzeichen? Datumsformatierung?) bei der Weiterverarbeitung des Wertes vermieden.

Parameter

ParameterType
fieldNamestring

Rückgabewert

unknown

Inhalt des Feldes oder null wenn das Feld nicht vorhanden ist

Example

const dateValue = record.GetContentsValueByName("Datumsfeld");


GetRecordRefDescription()

GetRecordRefDescription(): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8662

Liefert die evaluierte Datensatzverweis-Formel für Kommentar/Betreff zurück. Im Fehlerfall wird ein leerer String zurückgeliefert.

Rückgabewert

string


GetRelationalRecordSet()

GetRelationalRecordSet(relationField): RecordSet;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8672

Liefert ein RecordSet aufgrund einer relationalen Struktur zurück.

Parameter

ParameterTypeDescription
relationFieldstringBezeichnung der Relation, z.B.

Rückgabewert

RecordSet


Lock()

Lock(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8689

Sperrt den aktuellen Datensatz für die Bearbeitung durch andere Benutzer und sollte vor dem Ändern eines Datensatzes durch SetContents...aufgerufen werden.

Rückgabewert

boolean


PrintCard()

Aufrufsignatur

PrintCard(
media,
fileName,
silent,
outputFileName): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8702

Druckt ein Karteikartenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.

Parameter
ParameterTypeDescription
mediastringAusgabe-Medium
fileNamestringDateiname inkl. Pfad der Druckvorlage
silentbooleanLegt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll.
outputFileNamestringEvtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden.
Rückgabewert

boolean

Aufrufsignatur

PrintCard(
media,
fileName,
silent,
outputFileName,
useModalPreviewWindow): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8713

Druckt ein Karteikartenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.

Parameter
ParameterTypeDescription
mediastringAusgabe-Medium
fileNamestringDateiname inkl. Pfad der Druckvorlage
silentbooleanLegt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll.
outputFileNamestringEvtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden.
useModalPreviewWindowbooleanLegt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ).
Rückgabewert

boolean


PrintLabel()

Aufrufsignatur

PrintLabel(
media,
fileName,
silent,
outputFileName): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8736

Druckt ein Etikettenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.

Parameter
ParameterTypeDescription
mediastringAusgabe-Medium
fileNamestringDateiname inkl. Pfad der Druckvorlage
silentbooleanLegt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll.
outputFileNamestringEvtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden.
Rückgabewert

boolean

Aufrufsignatur

PrintLabel(
media,
fileName,
silent,
outputFileName,
useModalPreviewWindow): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8747

Druckt ein Etikettenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.

Parameter
ParameterTypeDescription
mediastringAusgabe-Medium
fileNamestringDateiname inkl. Pfad der Druckvorlage
silentbooleanLegt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll.
outputFileNamestringEvtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden.
useModalPreviewWindowbooleanLegt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ).
Rückgabewert

boolean


PrintReport()

Aufrufsignatur

PrintReport(
media,
fileName,
silent,
outputFileName): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8770

Druckt ein Listenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.

Parameter
ParameterTypeDescription
mediastringAusgabe-Medium
fileNamestringDateiname inkl. Pfad der Druckvorlage
silentbooleanLegt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll.
outputFileNamestringEvtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden.
Rückgabewert

boolean

Aufrufsignatur

PrintReport(
media,
fileName,
silent,
outputFileName,
useModalPreviewWindow): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8781

Druckt ein Listenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.

Parameter
ParameterTypeDescription
mediastringAusgabe-Medium
fileNamestringDateiname inkl. Pfad der Druckvorlage
silentbooleanLegt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll.
outputFileNamestringEvtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden.
useModalPreviewWindowbooleanLegt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ).
Rückgabewert

boolean


RemoveFromBlacklist()

RemoveFromBlacklist(fieldName): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8803

Entfernt den Inhalt des übergebenen Feldes aus der Sperrliste. Dabei wird die zugehörige Auto-Protokoll Aktion "Aus Sperrliste entfernen" ausgelöst.

Parameter

ParameterTypeDescription
fieldNamestringFeldname, dessen Inhalt in die Sperrliste entfernt werden soll.

Rückgabewert

boolean

false wenn der Inhalt nicht aus der Sperrliste entfernt werden konnte weil z.B. der interne Feldtyp nicht unterstützt wird, andernfalls true


Save()

Save(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8814

Speichert einen mit Hilfe von SetContents... geänderten Datensatz in die Datenbank; zuvor sollte der Datensatz immer mit Lock() gesperrt werden.

Rückgabewert

boolean

true wenn der Datensatz gespeichert werden konnte, andernfalls false


SaveRecordRef()

SaveRecordRef(fileName): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8824

Speichert einen Datensatzverweis.

Parameter

ParameterTypeDescription
fileNamestringPfad + Dateiname + Dateiendung des zu speichernden Adressverweises.

Rückgabewert

boolean


SendMailDirect()

SendMailDirect(
eMailAddress,
subject,
contents,
files): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8838

Sendet eine eMail mit Anhang entsprechend den Einstellungen unter "Konfigurieren > Allgemein" ohne Benutzer-Interaktion. Die automatische eMail-Ablage wird bei dieser Methode aktiviert. Die eMail wird, sofern konfiguriert, im Kontext des aktuellen Datensatz hinterlegt, bzw. verknüpft.

Parameter

ParameterTypeDescription
eMailAddressstringEmpfänger eMail-Adresse
subjectstringBetreff der eMail.
contentsstringText der eMail.
filesstringKann eine Liste von E-Mail-Anhängen beinhalten. Diese müssen dann per Semikolon separiert übergeben werden. Hinweis: Wenn in den allgemeinen Einstellungen "Mail per Kontextmenü über" auf "auf 'mailto:' registrierten Mail-Client" gestellt ist, hat dieser Parameter keine Auswirkung.

Rückgabewert

boolean


SendRecordRef()

SendRecordRef(
emailAddress,
subject,
content): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8850

Sendet eine eMail mit dem Datensatzverweis des aktuellen Datensatzes.

Parameter

ParameterTypeDescription
emailAddressstringEmpfänger eMail-Adresse.
subjectstringBetreff der eMail.
contentstringText der eMail.

Rückgabewert

boolean


SendSingleMail()

Aufrufsignatur

SendSingleMail(templatePath): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8860

Sendet eine Einzelmail ohne Dialog. Es wird der vollständige Pfad der Vorlagedatei übergeben.

Parameter
ParameterTypeDescription
templatePathstringVollständiger Pfad der Vorlagedatei.
Rückgabewert

boolean

Aufrufsignatur

SendSingleMail(templatePath, files): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8869

Sendet eine Einzelmail ohne Dialog. Es wird der vollständige Pfad der Vorlagedatei übergeben.

Parameter
ParameterTypeDescription
templatePathstringVollständiger Pfad der Vorlagedatei.
filesstringKann eine Liste von E-Mail-Anhängen beinhalten.Diese müssen dann per Semikolon separiert übergeben werden. Beachten Sie bitte, dass die übergebenen Anhänge stets zusätzlich zu den evtl. bereits in einer über den Parameter " templatePath " definierten Mailvorlage hinterlegten Anhängen versendet werden. Dies gilt auch dann, wenn ein übergebener eMail Anhang denselben Pfad hat wie in der Mailvorlage.
Rückgabewert

boolean


SendSingleMailDialog()

Aufrufsignatur

SendSingleMailDialog(templatePath): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8889

Sendet eine Einzelmail mit vorherigem Dialog. Es wird der vollständige Pfad der Vorlagedatei übergeben.

Parameter
ParameterTypeDescription
templatePathstringVollständiger Pfad der Vorlagedatei.
Rückgabewert

boolean

Aufrufsignatur

SendSingleMailDialog(templatePath, files): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8898

Sendet eine Einzelmail mit vorherigem Dialog. Es wird der vollständige Pfad der Vorlagedatei übergeben.

Parameter
ParameterTypeDescription
templatePathstringVollständiger Pfad der Vorlagedatei.
filesstringKann eine Liste von E-Mail-Anhängen beinhalten.Diese müssen dann per Semikolon separiert übergeben werden. Beachten Sie bitte, dass die übergebenen Anhänge stets zusätzlich zu den evtl. bereits in einer über den Parameter " templatePath " definierten Mailvorlage hinterlegten Anhängen versendet werden. Dies gilt auch dann, wenn ein übergebener eMail Anhang denselben Pfad hat wie in der Mailvorlage.
Rückgabewert

boolean


SetContentsByFormula()

SetContentsByFormula(fieldName, formula): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8919

Legt den Inhalt des Feldes mit einer Formel fest, dessen Feldname übergeben wurde. Das Setzen eines Primärschlüssels ist möglich, sofern das Schreiben erlaubt ist.

Parameter

ParameterTypeDescription
fieldNamestringPhysikalischer Name des gewünschten Feldes.
formulastringFeldinhalt aus einer Formel.

Rückgabewert

boolean


SetContentsByName()

SetContentsByName(fieldName, contents): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8932

Legt den Inhalt des Feldes fest, dessen physikalischer Feldname übergeben wurde. Das Setzen eines Primärschlüssels ist möglich, sofern das Schreiben erlaubt ist.

Parameter

ParameterTypeDescription
fieldNamestringPhysikalischer Name des gewünschten Feldes.
contentsstring(Neuer) Feldinhalt

Rückgabewert

boolean

true wenn der Wert gesetzt werden konnte, andernfalls false


SetContentsByNameFromFile()

SetContentsByNameFromFile(fieldName, fileName): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8943

Die angegebene Datei wird in das übergebene BLOB-Feld eingebettet.

Parameter

ParameterTypeDescription
fieldNamestringPhysikalischer Name des gewünschten (BLOB)-Felds.
fileNamestringDateipfad

Rückgabewert

boolean


SetContentsByNameToNull()

SetContentsByNameToNull(fieldName): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8953

Setzt Feld auf null . Bitte beachten Sie, dass die Methode nicht prüft, ob ein Feld in der Datenbank überhaupt null sein darf!

Parameter

ParameterTypeDescription
fieldNamestringPhysikalischer Name des gewünschten (BLOB)-Felds.

Rückgabewert

boolean


SetContentsValueByFormula()

SetContentsValueByFormula(fieldName, formula): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8964

Legt den Inhalt des Feldes mit einer Formel fest, dessen Feldname übergeben wurde. Das Setzen eines Primärschlüssels ist möglich, sofern das Schreiben erlaubt ist.

Parameter

ParameterTypeDescription
fieldNamestringPhysikalischer Name des gewünschten Feldes.
formulaanyFeldinhalt aus einer Formel.

Rückgabewert

boolean


SetContentsValueByName()

SetContentsValueByName(fieldName, content): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8977

Legt den Inhalt des Feldes fest, dessen physikalischer Feldname übergeben wurde. Die übergebene Variable für den Inhalt kann dabei einen zum Feldtyp korrespondierenden Typ haben und muss nicht vorher in eine Zeichenkette umgewandelt werden.Somit werden bspw. Lokalisierungsprobleme (Komma oder Punkt als Dezimalzeichen? Datumsformatierung?) bei der Weiterverarbeitung des Wertes vermieden. Das Setzen eines Primärschlüssels ist möglich, sofern das Schreiben erlaubt ist.

Parameter

ParameterTypeDescription
fieldNamestringPhysikalischer Name des gewünschten Feldes.
contentany(Neuer) Feldinhalt

Rückgabewert

boolean

true wenn der Wert gesetzt werden konnte, andernfalls false


TransferData()

TransferData(transferTemplate): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8987

Führt die Einzelübernahme mit einer als Parameter übergebenen Übernahmemaske durch.

Parameter

ParameterTypeDescription
transferTemplatestringPfad und Dateiname der Übernahmemaske. Die Platzhalter %APPDIR% und %PRJDIR% werden unterstützt.

Rückgabewert

boolean


Unlock()

Unlock(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:8998

Entsperrt einen zuvor mit Lock() gesperrten Datensatz wieder und ermöglicht somit die Änderung durch andere Benutzer.

Rückgabewert

boolean

true wenn der Datensatz entsperrt werden konnte, andernfalls false


[hasInstance]()

static hasInstance: boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v11.ts:9029

Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.

Parameter

ParameterType
valueany

Rückgabewert

boolean