|
|
|
LotusScript Object ModelHere is a link to IBM/Lotus for the full online LotusScript Object Model for R5.
Here is a portion of the Cross-reference from previous version of Lotus Notes Class Property/Method Syntax ----------------------------------------------------------------- NotesACL Property Parent Set notesDatabase = notesACL.Parent Roles stringArray = notesACL.Roles UniformAccess flag = notesACL.UniformAccess / notesACL.UniformAccess = flag Method AddRole notesACL.AddRole( name$ ) CreateACLEntry notesACLEntry = notesACL.CreateACLEntry( name$, level% ) DeleteRole Call notesACL.DeleteRole( name$ ) GetEntry notesACLEntry = notesACL.GetEntry( name$ ) GetFirstEntry Set notesACLEntry = notesACL.GetFirstEntry GetNextEntry Set notesACLEntry = notesACL.GetNextEntry( notesACLEntry ) RenameRole Set notesACLEntry = notesACL.GetNextEntry( notesACLEntry ) Save Call notesACL.Save NotesACLEntry Property CanCreateDocuments flag = notesACLEntry.CanCreateDocuments CanCreatePersonalAgent flag = notesACLEntry.CanCreatePersonalAgent CanCreatePersonalFolder flag = notesACLEntry.CanCreatePersonalFolder CanDeleteDocuments flag = notesACLEntry.CanDeleteDocuments IsPublicReader flag = notesACLEntry.IsPublicReader IsPublicWriter flag = notesACLEntry.IsPublicWriter Level level% = notesACLEntry.Level Name name$ = notesACLEntry.Name Parent Set notesACL = notesACLEntry.Parent Roles stringArray = notesACLEntry.Roles Method DisableRole notesACLEntry.DisableRole( name$ ) EnableRole Call notesACLEntry.EnableRole( name$ ) IsRoleEnabled flag = notesACLEntry.IsRoleEnabled( name$ ) Remove Call notesACLEntry.Remove
NotesDatabase Property ACL Set notesACL = notesDatabase.ACL Agents notesAgentArray = notesDatabase.Agents AllDocuments Set notesDocumentCollection = notesDatabase.AllDocuments Categories categoryList$ = notesDatabase.Categories Created dateV = notesDatabase.Created CurrentAccessLevel level% = notesDatabase.CurrentAccessLevel DelayUpdates flag = notesDatabase.DelayUpdates DesignTemplateName name$ = notesDatabase.DesignTemplateName FileName fileName$ = notesDatabase.FileName FilePath path$ = notesDatabase.FilePath Forms notesForm Array = notesDatabase.Forms IsFTIndexed flag = notesDatabase.IsFTindexed IsMultiDbSearch flag = notesDatabase.IsMultiDbSearch IsOpen flag = notesDatabase.IsOpen IsPrivateAddressBook flag = notesDatabase.IsPrivateAddressBook IsPublicAddressBook flag = notesDatabase.IsPublicAddressBook LastFTIndexed dateV = notesDatabase.LastFTIndexed LastModified dateV = notesDatabase.LastModified Managers stringArray = notesDatabase.Managers Parent Set notesSession = notesDatabase.Parent PercentUsed used# = notesDatabase.PercentUsed ReplicaID id$ = notesDatabase.ReplicaID Server serverName$ = notesDatabase.Server Size size# = notesDatabase.Size SizeQuota quota& = notesDatabase.SizeQuota TemplateName name$ = notesDatabase.TemplateName Title title$ = notesDatabase.Title UnprocessedDocuments Set notesDocumentCollection = notesDatabase.UnprocessedDocuments Views notesViewArray = notesDatabase.Views Method Compact sizeDelta& = notesDatabase.Compact Create Call notesDatabase.Create( server$, dbfile$, openFlag ) CreateCopy Set notesDatabase = notesDatabase.CreateCopy( newServer$, newDbFile$ ) CreateDocument Set notesDocument = notesDatabase.CreateDocument CreateFromTemplate Set notesDatabase = notesDatabase.CreateFromTemplate( newServer$, newDbFile$, inheritFlag ) CreateReplica Set notesDatabase = notesDatabase.CreateReplica( newServer$, newDbFile$ ) FTSearch Set notesDocumentCollection = notesDatabase.FTSearch( query$, maxDocs% [,sortoptions [, otheroptions]] ) GetAgent Set notesAgent = notesDatabase.GetAgent( agentName$ ) GetDocumentByID Set notesDocument = notesDatabase.GetDocumentByID( noteID$ ) GetDocumentByUNID Set notesDocument = notesDatabase.GetDocumentByUNID( unid$ ) GetDocumentByURL Set notesDocument = notesDatabase.GetDocumentByURL( URL$ [ , reload ] [ , urllist ] [ , charset$ ] [ , webu GetForm Set notesForm = notesDatabase.GetForm( name$ ) GetProfileDocument Set notesDocument = notesDatabase.GetProfileDocument( profilename$ [ , username$] ) GetURLHeaderInfo header$ = notesDatabase.GetURLHeaderInfo( URL$ , headername$ [ , Webusername$ ] [ , Webpassword$ ] [ , Prox GetView Set notesView = notesDatabase.GetView( viewName$ ) GrantAccess Call notesDatabase.GrantAccess( name$, level% ) Open flag = notesDatabase.Open( server$, dbfile$ ) OpenByReplicaID flag = notesDatabase.OpenByReplicaID( server$, replicaID$ ) OpenIfModified flag = notesDatabase.OpenIfModified( server$, dbfile$, notesDateTime ) OpenMail Call notesDatabase.OpenMail OpenURLDb flag = notesDatabase.OpenURLDb OpenWithFailover flag = notesDatabase.OpenWithFailover( server$, dbfile$ ) QueryAccess level% = notesDatabase.QueryAccess( name$ ) Remove Call notesDatabase.Remove Replicate flag = notesDatabase.Replicate( serverName$ ) RevokeAccess Call notesDatabase.RevokeAccess( name$ ) Search Set notesDocumentCollection = notesDatabase.Search( formula$, notesDateTime, maxDocs% ) UnprocessedFTSearch Set notesDocumentCollection = notesDatabase.UnprocessedFTSearch( query$, maxDocs% [,sortoptions [, other UnprocessedSearch Set notesDocumentCollection = notesDatabase.UnprocessedSearch( formula$, notesDateTime, maxDocs% ) UpdateFTIndex Call notesDatabase.UpdateFTIndex( createFlag )
NotesDocument Property Authors authorArray = notesDocument.Authors ColumnValues valueArray = notesDocument.ColumnValues Created dateV = notesDocument.Created EmbeddedObjects notesEmbeddedObjectArray = notesDocument.EmbeddedObjects EncryptionKeys stringArray = notesDocument.EncryptionKeys EncryptOnSend flag = notesDocument.EncryptOnSend FTSearchScore score% = notesDocument.FTSearchScore HasEmbedded flag = notesDocument.HasEmbedded IsNewNote flag = notesDocument.IsNewNote IsProfile flag = notesDocument.IsProfile IsResponse flag = notesDocument.IsResponse IsSigned flag = notesDocument.IsSigned IsUIDocOpen flag = notesDocument.IsUIDocOpen Items notesItemArray = notesDocument.Items Key string = notesDocument.Key LastAccessed dateV = notesDocument.LastAccessed LastModified dateV = notesDocument.LastModified NameOfProfile To get string = notesDocument.NameOfProfile NoteID noteid$ = notesDocument.NoteID ParentDatabase Set notesDatabase = notesDocument.ParentDatabase ParentDocumentUNID parentUnid$ = notesDocument.ParentDocumentUNID ParentView Set notesView = notesDocument.ParentView Responses Set notesDocumentCollection = notesDocument.Responses SaveMessageOnSend flag = notesDocument.SaveMessageOnSend SentByAgent flag = notesDocument.SentByAgent Signer signer$ = notesDocument.Signer SignOnSend flag = notesDocument.SignOnSend Size size& = notesDocument.Size UniversalID unid$ = notesDocument.UniversalID Verifier verifier$ = notesDocument.Verifier Method AppendItemValue Set notesItem = notesDocument.AppendItemValue( itemName$, value ) ComputeWithForm flag = notesDocument.ComputeWithForm( doDataTypes, raiseError ) CopyAllItems Call notesDocument.CopyAllItems( notesDocument [, replace] ) CopyItem Set notesItem = notesDocument.CopyItem( notesItem, newName$ ) CopyToDatabase Set notesDocument = notesDocument.CopyToDatabase( notesDatabase ) CreateReplyMessage Set notesDocument = notesDocument.CreateReplyMessage( all ) CreateRichTextItem Set notesRichTextItem = notesDocument.CreateRichTextItem( name$ ) Encrypt Call notesDocument.Encrypt GetAttachment Set notesEmbeddedObject = notesDocument.GetAttachment( fileName$ ) GetFirstItem Set notesItem = notesDocument.GetFirstItem( name$ ) GetItemValue valueArray = notesDocument.GetItemValue( itemName$ ) HasItem flag = notesDocument.HasItem( itemName$ ) MakeResponse Call notesDocument.MakeResponse( notesDocument ) PutInFolder Call notesDocument.PutInFolder( folderName$ ) Remove flag = notesDocument.Remove( force ) RemoveFromFolder Call notesDocument.RemoveFromFolder( folderName$ ) RemoveItem Call notesDocument.RemoveItem( itemName$ ) RenderToRTItem flag = notesDocument.RenderToRTItem( notesRichTextItem ) ReplaceItemValue Set notesItem = notesDocument.ReplaceItemValue( itemName$, value ) Save flag = notesDocument.Save( force, createResponse [ , markRead ]) Send Call notesDocument.Send( attachForm [, recipients ] ) Sign Call notesDocument.Sign NotesForm Property Aliases stringArray = notesForm.Aliases Fields stringArray = notesForm.Fields FormUsers stringArray = notesForm.FormUsers IsSubForm flag = notesForm.IsSubForm Name string = notesForm.Name ProtectReaders flag = notesForm.ProtectReaders ProtectUsers flag = notesForm.ProtectUsers Readers stringArray = notesForm.Readers Method Remove Call notesForm.Remove
NotesItem Property DateTimeValue Set notesDateTime = notesItem.DateTimeValue IsAuthors flag = notesItem.IsAuthors IsEncrypted flag = notesItem.IsEncrypted IsNames flag = notesItem.IsNames IsProtected flag = notesItem.IsProtected IsReaders flag = notesItem.IsReaders IsSigned flag = notesItem.IsSigned IsSummary flag = notesItem.IsSummary LastModified dateV = notesItem.LastModified Name itemName$ = notesItem.Name Parent Set notesDocument = notesItem.Parent SaveToDisk flag = notesItem.SaveToDisk Text itemText$ = notesItem.Text Type itemType% = notesItem.Type ValueLength size% = notesItem.ValueLength Values valueArray = notesItem.Values Method Abstract abbreviation$ = notesItem.Abstract( maxAbstract&, dropVowels, useDictionary ) AppendToTextList Call notesItem.AppendToTextList( newValue ) Contains flag = notesItem.Contains( value ) CopyItemToDocument Set notesItem = notesItem.CopyItemToDocument( notesDocument, newName$ ) Remove Call notesItem.Remove NotesRichTextItem Property EmbeddedObjects notesEmbeddedObjectArray = notesRichTextItem.EmbeddedObjects Method AddNewLine Call notesRichTextItem.AddNewLine( n% [, forceParagraph ]) AddTab Call notesRichTextItem.AddTab( n% ) AppendDocLink Call notesRichTextItem.AppendDocLink( linkTo, comment$ ) AppendRTFile Call notesRichTextItem.AppendRTFile( path$ ) AppendRTItem Call notesRichTextItem.AppendRTItem( notesRichTextItem ) AppendText Call notesRichTextItem.AppendText( text$ ) EmbedObject Set notesEmbeddedObject = notesRichTextItem.EmbedObject( type%, class$, source$, [ name$ ] ) GetEmbeddedObject Set notesEmbeddedObject = notesRichTextItem.GetEmbeddedObject( name$ ) GetFormattedText plainText$ = notesRichTextItem.GetFormattedText( tabstrip, lineLength% )
NotesSession Property AddressBooks notesDatabaseArray = notesSession.AddressBooks CommonUserName commonName$ = notesSession.CommonUserName CurrentAgent Set notesAgent = notesSession.CurrentAgent CurrentDatabase Set notesDatabase = notesSession.CurrentDatabase DocumentContext Set notesDocument = notesSession.DocumentContext EffectiveUserName name$ = notesSession.EffectiveUserName International Set notesInternational = notesSession.International IsOnServer flag = notesSession.IsOnServer LastExitStatus code% = notesSession.LastExitStatus LastRun dateV = notesSession.LastRun NotesVersion version$ = notesSession.NotesVersion Platform platform$ = notesSession.Platform SavedData Set notesDocument = notesSession.SavedData UserName name$ = notesSession.UserName Method CreateDateRange Set notesDateRange = notesSession.CreateDateRange( ) CreateDateTime Set notesDateTime = notesSession.CreateDateTime( dateTime$ ) CreateLog Set notesLog = notesSession.CreateLog( programName$ ) CreateName Set notesName = notesSession.CreateName( name$ ) CreateNewsletter Set notesNewsletter = notesSession.CreateNewsletter( notesDocumentCollection ) CreateTimer Set notesTimer = notesSession.CreateTimer( ) FreeTimeSearch Set notesDateRange = notesSession.FreeTimeSearch( window, duration, names [, firstfit] ) GetDatabase Set notesDatabase = notesSession.GetDatabase( server$, dbfile$ ) GetDbDirectory Set notesDbDirectory = notesSession.GetDbDirectory( serverName$ ) GetEnvironmentString valueV = notesSession.GetEnvironmentString( name$ [ , system ] ) GetEnvironmentValue valueV = notesSession.GetEnvironmentValue( name$ [ , system ] ) SetEnvironmentVar Call notesSession.SetEnvironmentVar( name$, valueV [, issystemvar] ) UpdateProcessedDoc Call notesSession.UpdateProcessedDoc( notesDocument )
NotesUIDatabase Property Database Set notesDatabase = notesUIDatabase.Database Documents Set notesDocumentCollection = notesUIDatabase.Documents Method OpenView Call notesUIDatabase.OpenView( viewName$ ) Event PostDocumentDelete event PostDocumentDelete(Source as Notesuidatabase) PostOpen event PostOpen(Source As Notesuidatabase) QueryClose event QueryClose(Source As Notesuidatabase, Continue As Variant) QueryDocumentDelete event QueryDocumentDelete(Source As Notesuidatabase, Continue As Variant) QueryDocumentUndelete event QueryDocumentUndelete(Source As Notesuidatabase, Continue As Variant) NotesUIView Property CalendarDateTime dateV = notesUIView.CalendarDateTime Documents Set notesDocumentCollection = notesUIView.Documents View Set notesView = notesUIView.View Event PostDragDrop event PostOpen event PostPaste event QueryAddToFolder event QueryClose event QueryDragDrop event QueryOpen event QueryOpenDocument event QueryPaste event QueryRecalc event RegionDoubleClick event NotesUIWorkspace Property CurrentCalendarDateTime dateV = notesUIWorkspace.CurrentCalendarDateTime CurrentDocument Set notesUIDocument = notesUIWorkspace.CurrentDocument Method AddDatabase Call notesUIWorkspace.AddDatabase( server$ , filename$ ) CheckAlarms Call notesUIWorkspace.CheckAlarms( ) ComposeDocument Set notesUIDocument = notesUIWorkspace.ComposeDocument( [ server$ [ , file$ [ , form$ [ , windowWidth# [ , DialogBox flag = notesUIWorkspace.DialogBox( form$ [ , autoHorzFit [ , autoVertFit [, noCancel [, noNewFields [, EditDocument Set notesUIDocument = notesUIWorkspace.EditDocument( [editMode [, notesDocument [, notesDocumentReadOnly]]] EditProfile Call notesUIWorkspace.EditProfile( profileName$ [ , userName$] ) EnableAlarms flag = notesUIWorkspace.EnableAlarms( enable ) OpenDatabase Call notesUIWorkspace.OpenDatabase( server$, file$, view$, key$, newInstance, temp ) URLOpen Call notesUIWorkspace.URLOpen( Url$, reload, urlList, charset$, webusername$, webpassword$, proxywebusernam UseLSX Call notesUIWorkspace.UseLSX( lsxLibraryName$ ) ViewRefresh Call notesUIWorkspace.ViewRefresh
NotesView Property Aliases aliases = notesView.Aliases AutoUpdate flag = notesView.AutoUpdate Columns notesViewColumnArray = notesView.Columns Created dateV = notesView.Created IsCalendar flag = notesView.IsCalendar IsDefaultView flag = notesView.IsDefaultView IsFolder flag = notesView.IsFolder LastModified dateV = notesView.LastModified Name name$ = notesView.Name Parent Set notesDatabase = notesView.Parent ProtectReaders flag = notesView.ProtectReaders Readers stringArray = notesView.Readers UniversalID unid$= notesView.UniversalID Method Clear Call notesView.Clear FTSearch numDocs% = notesView.FTSearch( query$, maxDocs% ) GetAllDocumentsByKey Set notesDocumentCollection = notesView.GetAllDocumentsByKey( keyArray [ ,exact ] ) GetChild Set notesDocument = notesView.GetChild( notesDocument ) GetDocumentByKey Set notesDocument = notesView.GetDocumentByKey( keyArray [ , exact ] ) GetFirstDocument Set notesDocument = notesView.GetFirstDocument GetLastDocument Set notesDocument = notesView.GetLastDocument GetNextDocument Set notesDocument = notesView.GetNextDocument( notesDocument ) GetNextSibling Set notesDocument = notesView.GetNextSibling( notesDocument ) GetNthDocument Set notesDocument = notesView.GetNthDocument( n% ) GetParentDocument Set notesDocument = notesView.GetParentDocument( notesDocument ) GetPrevDocument Set notesDocument = notesView.GetPrevDocument( notesDocument ) GetPrevSibling Set notesDocument = notesView.GetPrevSibling( notesDocument ) Refresh Call notesView.Refresh Remove Call notesView.Remove NotesViewColumn Property Formula formula$ = notesViewColumn.Formula IsCategory flag = notesViewColumn.IsCategory IsHidden flag = notesViewColumn.IsHidden IsResponse flag = notesViewColumn.IsResponse IsSorted flag = notesViewColumn.IsSorted ItemName name$ = notesViewColumn.ItemName Position pos% = notesViewColumn.Position Title title$ = notesViewColumn.Title
|
|
|
