| Class TNotesDocument (unit Class_LotusNotes) |
TPersistent
Notes document
| Constructors |
constructor Create (notesDatabase: TNotesDatabase; anId: longint);
constructor CreateNew(notesDatabase: TNotesDatabase);| Functions |
function Attach (AName: string): integer;*****************************************************************************)
procedure DeleteItem (ItemName: string);**********************************************
destructor Destroy;*****************************************************************************)
procedure Detach (Index: integer; FileName: string);*****************************************************************************)
function FindAttachment(aName: string): integer;
function GetSignature (var SignedBy: string; var CertifiedBy: string; pTime: PTDateTime): boolean;
function IsItemExists(ItemName: string): boolean;***************************************************
procedure ReloadFields;*****************************************************************************)
function ReplaceItemValue(itemName: string; value: Variant): TNotesItem;
procedure Save(force, createResponse, markRead: boolean);*****************************************************************************)
procedure Send(attachForm: boolean; ARecipients: string);*****************************************************************************)
procedure Sign;
function GetAttachment(Index: integer): string;
function GetAttachmentCount: integer;
function GetBodyAsMemo: TStrings;
function GetBodyAsString: string;
function GetFieldCount : longint;
function GetFieldName (Index: integer): string;
function GetItemByName (ItemName: string): TNotesItem;
function GetItemByNum (ItemNum: integer): string;
function GetRecipients: string;
procedure LoadFontTable;
procedure SaveFontTable;
procedure SetBodyAsMemo(Value: TStrings);
procedure SetBodyAsString(Value: string);
procedure SetItemByNum (ItemNum: integer; Value: string);
procedure SetRecipients(Value: string);| Properties |
property Attachment : string
property AttachmentCount : integer
property Body : TStrings
property BodyAsString : string
property Database : TNotesDatabase
property DocID : integer
property FieldCount : longint
property FieldName : string
property Form : string
property Handle : integer
property Items : TNotesItem
property MailFrom : string
property Recipients : string
property SendTo : string
property Subject : string| Events |
| Variables |
FAttach : TStrings;
FDatabase : TNotesDatabase;
FFields : TStringList;
FFontTable : TStringList;
fHandle : integer;
fId : integer;
FMaxAttachment : word;
FMaxFontID : word;| Constructors |
constructor Create (notesDatabase: TNotesDatabase; anId: longint);create new DOCUMENT in the database (see also TNotesDatabase.CreateDocument
*****************************************************************************)
constructor CreateNew(notesDatabase: TNotesDatabase);ClassMarker_Method(TNotesRichTextItem) (******************************************************************************) { TNotesDocument} (
| Functions |
function Attach (AName: string): integer;return index in Attachment or -1
*****************************************************************************)
procedure DeleteItem (ItemName: string);detach a file attached to a form with a given name
**********************************************
destructor Destroy;open a document by its UNID
*****************************************************************************)
procedure Detach (Index: integer; FileName: string);attach a file by its name
*****************************************************************************)
function FindAttachment(aName: string): integer;***************************************************
function GetSignature (var SignedBy: string; var CertifiedBy: string; pTime: PTDateTime): boolean;sends a document. if ARecipients <> '', overrides previously assigned addressees if Database.SaveMail = True, also saves a document
**********************************************
function IsItemExists(ItemName: string): boolean;deletes an item
***************************************************
procedure ReloadFields;Clears fields list and reloads it from the document Call Save before to commit changes
*****************************************************************************)
function ReplaceItemValue(itemName: string; value: Variant): TNotesItem;*****************************************************************************)
procedure Save(force, createResponse, markRead: boolean);sets field value
*****************************************************************************)
procedure Send(attachForm: boolean; ARecipients: string);saves a document
*****************************************************************************)
procedure Sign;Get signature information. SignedBy is user name, CertifiedBy - domain name. pTime can be nil Returns True if document is signed and signature is valid
**********************************************
function GetAttachment(Index: integer): string;***************************************************
function GetAttachmentCount: integer;***************************************************
function GetBodyAsMemo: TStrings;*****************************************************************************)
function GetBodyAsString: string;*****************************************************************************)
function GetFieldCount : longint;**********************************************
function GetFieldName (Index: integer): string;**********************************************
function GetItemByName (ItemName: string): TNotesItem;**********************************************
function GetItemByNum (ItemNum: integer): string;*****************************************************************************)
function GetRecipients: string;*****************************************************************************)
procedure LoadFontTable;***************************************************
procedure SaveFontTable;***************************************************
procedure SetBodyAsMemo(Value: TStrings);*****************************************************************************)
procedure SetBodyAsString(Value: string);*****************************************************************************)
procedure SetItemByNum (ItemNum: integer; Value: string);*****************************************************************************)
procedure SetRecipients(Value: string);*****************************************************************************)
| Properties |
property Attachment : stringnumber of file attachments
property AttachmentCount : integerThese are Document attachment handling
property Body : TStringsList of recipients If recipients = '', then SendTo field is used
property BodyAsString : stringbody field
property Database : TNotesDatabase
property DocID : integersigns a document
property FieldCount : longintItems Use Items[Name].As... to read/write document properties
property FieldName : string
property Form : stringSpecial fields for mail documents Note that using this fields do not change doc items obtained from Items property
property Handle : integer
property Items : TNotesItem
property MailFrom : stringAddressee - ONLY ONE ADDRESS! For multiple addresses use Recipients
property Recipients : stringsender
property SendTo : stringsubject field
property Subject : stringform name
| Events |
| Variables |
FAttach : TStrings;
FDatabase : TNotesDatabase;
FFields : TStringList;
FFontTable : TStringList;
fHandle : integer;
fId : integer;
FMaxAttachment : word;
FMaxFontID : word;