Button Class
Events:
Click event Click(Source As Button)
ObjectExecute event ObjectExecute(Source As Button, Data As Variant)
Field Class
Events:
Entering event Entering(Source as Field)
Exiting event Exiting(Source as Field)
OnBlur event OnBlur(Source as Field)
OnChange event OnChange(Source as Field)
OnFocus event OnFocus(Source as Field)
Navigator Class
Events:
Click event Click(Source as Navigator)
NotesACL Class
Properties:
AdministrationServer property serverName$ = notesACL.AdministrationServer
InternetLevel property level% = notesACL.InternetLevel
IsAdminNames property flag = notesACL.IsAdminNames
IsAdminReaderAuthor property flag = notesACL.IsAdminReaderAuthor
IsExtendedAccess property flag = notesACL.ExtendedAccess
Parent property Set notesDatabase = notesACL.Parent
Roles property stringArray = notesACL.Roles
UniformAccess property flag = notesACL.UniformAccess
Methods:
AddRole method Call notesACL.AddRole( name$ )
CreateACLEntry method Set notesACLEntry = notesACL.CreateACLEntry( name$, level% )
DeleteRole method Call notesACL.DeleteRole( name$ )
GetEntry method Set notesACLEntry = notesACL.GetEntry( name$ )
GetFirstEntry method Set notesACLEntry = notesACL.GetFirstEntry
GetNextEntry method Set notesACLEntry = notesACL.GetNextEntry( entry )
RemoveACLEntry method Call notesACL.RemoveACLEntry( name$ )
RenameRole method Call notesACL.RenameRole( oldName$, newName$ )
Save method Call notesACL.Save
NotesACLEntry Class
Properties:
CanCreateDocuments property flag = notesACLEntry.CanCreateDocuments
CanCreateLSOrJavaAgent property flag = notesACLEntry.CanCreateLSOrJavaAgent
CanCreatePersonalAgent property flag = notesACLEntry.CanCreatePersonalAgent
CanCreatePersonalFolder property flag = notesACLEntry.CanCreatePersonalFolder
CanCreateSharedFolder property flag = notesACLEntry.CanCreateSharedFolder
CanDeleteDocuments property flag = notesACLEntry.CanDeleteDocuments
CanReplicateOrCopyDocuments property flag = notesACLEntry.CanReplicateOrCopyDocuments
IsAdminReaderAuthor property flag = notesACLEntry.IsAdminReaderAuthor
IsAdminServer property flag = notesACLEntry.IsAdminServer
IsGroup property flag = notesACLEntry.IsGroup
IsPerson property flag = notesACLEntry.IsPerson
IsPublicReader property flag = notesACLEntry.IsPublicReader
IsPublicWriter property flag = notesACLEntry.IsPublicWriter
IsServer property flag = notesACLEntry.IsServer
Level property level% = notesACLEntry.Level
Name property name$ = notesACLEntry.Name
NameObject property Set notesName = notesACLEntry.NameObject
Parent property Set notesACL = notesACLEntry.Parent
Roles property stringArray = notesACLEntry.Roles
UserType property usertype% = notesACLEntry.UserType
Methods:
DisableRole method Call notesACLEntry.DisableRole( name$ )
EnableRole method Call notesACLEntry.EnableRole( name$ )
IsRoleEnabled method flag = notesACLEntry.IsRoleEnabled( name$ )
Remove method Call notesACLEntry.Remove
NotesAdministrationProcess Class
Properties:
CertificateAuthorityOrg property org$ = notesAdministrationProcess.CertificateAuthorityOrg
CertificateExpiration property Set notesDateTime = notesAdministrationProcess.CertificateExpiration
CertifierFile property filespec$ = notesAdministrationProcess.CertifierFile
CertifierPassword property password$ = notesAdministrationProcess.CertifierPassword
IsCertificateAuthorityAvailable property flag = notesAdministrationProcess.IsCertificateAuthorityAvailable
UseCertificateAuthority property flag = notesAdministrationProcess.UseCertificateAuthority
Methods:
AddGroupMembers method noteID$ = notesAdministrationProcess.AddGroupMembers( group$ , members )
AddInternetCertificateToUser method noteID$ = notesAdministrationProcess.AddInternetCertificateToUser( user$ , keyringfile$ , keyringpassword$ [ , expiration ] )
AddServerToCluster method noteID$ = notesAdministrationProcess.AddServerToCluster( server$ , cluster$ )
ApproveDeletePersonInDirectory method noteID$ = notesAdministrationProcess.ApproveDeletePersonInDirectory( noteID$ )
ApproveDeleteServerInDirectory method noteID$ = notesAdministrationProcess.ApproveDeleteServerInDirectory( noteID$ )
ApproveDesignElementDeletion method noteID$ = notesAdministrationProcess.ApproveDesignElementDeletion( noteID$ )
ApproveMailFileDeletion method noteID$ = notesAdministrationProcess.ApproveMailFileDeletion( noteID$ )
ApproveMovedReplicaDeletion method noteID$ = notesAdministrationProcess.ApproveMovedReplicaDeletion( noteID$ )
ApproveNameChangeRetraction method noteID$ = notesAdministrationProcess.ApproveNameChangeRetraction( noteID$ )
ApproveRenamePersonInDirectory method noteID$ = notesAdministrationProcess.ApproveRenamePersonInDirectory( noteID$ )
ApproveRenameServerInDirectory method noteID$ = notesAdministrationProcess.ApproveRenameServerInDirectory( noteID$ )
ApproveReplicaDeletion method noteID$ = notesAdministrationProcess.ApproveReplicaDeletion( noteID$ )
ApproveResourceDeletion method noteID$ = notesAdministrationProcess.ApproveResourceDeletion( noteID$ )
ChangeHTTPPassword method noteID$ = notesAdministrationProcess.ChangeHTTPPassword( username$ , oldpassword$ , newpassword$ )
ConfigureMailAgent method noteID$ = notesAdministrationProcess.ConfigureMailAgent( username$ , agentname$ [ , activatable ] [ , enable ] )
CreateReplica method noteID$ = notesAdministrationProcess.CreateReplica( sourceserver$ , sourcedbfile$ [ , destserver$ ] [ , destdbfile$ ] [ , copyacl ] [ , createftindex ] )
DeleteGroup method Call notesAdministrationProcess.DeleteGroup( groupname$ , immediate [ , deletewindowsgroup ] )
DeleteReplicas method noteID$ = notesAdministrationProcess.DeleteReplicas( servername$ , filename$ )
DeleteServer method Call notesAdministrationProcess.DeleteServer( servername$ , immediate )
DeleteUser method Call notesAdministrationProcess.DeleteUser( username$ , immediate , mailfileaction% , denygroup$ [ , deletewindowsuser ] )
FindGroupInDomain method noteID$ = notesAdministrationProcess.FindGroupInDomain( group$ )
FindServerInDomain method noteID$ = notesAdministrationProcess.FindServerInDomain( server$ )
FindUserInDomain method noteID$ = notesAdministrationProcess.FindUserInDomain( user$ )
MoveMailUser method noteID$ = notesAdministrationProcess.MoveMailUser( username$ , newhomeserver$ , newhomeservermailpath$ [ , usescos ] [ , newclusterreplicaarray$ ] [ , deleteoldclusterreplicas ] )
MoveReplica method noteID$ = notesAdministrationProcess.MoveReplica( sourceserver$ , sourcedbfile$ [ , destserver$ ] [ , destdbfile$ ] [ , copyacl ] [ , createftindex ] )
MoveRoamingUser method noteID$ = notesAdministrationProcess.MoveRoamingUser( username$ , destserver$ , destserverpath$ )
MoveUserInHierarchyComplete method noteID$ = notesAdministrationProcess.MoveUserInHierarchyComplete( requestnoteid$ [ , lastname$ ] [ , firstname$ ] [ , middleinitial$ ] [ , orgunit$ ] [ , altcommonname$ ] [ , altorgunit$ ] [ , altlangua
MoveUserInHierarchyRequest method noteID$ = notesAdministrationProcess.MoveUserInHierarchyRequest( username$ [ , targetcertifier$ ] [ , allowprimarynamechange ] )
RecertifyServer method noteID$ = notesAdministrationProcess.RecertifyServer( server$ )
RecertifyUser method noteID$ = notesAdministrationProcess.RecertifyUser( username$ )
RemoveServerFromCluster method noteID$ = notesAdministrationProcess.RemoveServerFromCluster( server$ )
RenameGroup method noteID$ = notesAdministrationProcess.RenameUser( group$ , newgroup$ )
RenameNotesUser method noteID$ = notesAdministrationProcess.RenameNotesUser( username$ [ , lastname$ ] [ , firstname$ ] [ , middleinitial$ ] [ , orgunit$ ] [ , altcommonname$ ] [ , altorgunit$ ] [ , altlanguage$ ] [ , renamew
RenameWebUser method noteID$ = notesAdministrationProcess.RenameWebUser( username$ , newfullname$ [ , newlastname$ ] [ , newfirstname$ ] [ , newmiddleinitial$ ] [ , newshortname$ ] [ , newinternetaddress ] )
SetServerDirectoryAssistanceSettings method noteID$ = notesAdministrationProcess.SetServerDirectoryAssistanceSettings( server$ , dbfile$ )
SetUserPasswordSettings method noteID$ = notesAdministrationProcess.SetUserPasswordSettings( username$ [ , notespasswordchecksetting$ ] [ , notespasswordchangeinterval$ ] [ , notespasswordgraceperiod$ ] [ , internetpasswordforcechang
SignDatabaseWithServerID method noteID$ = notesAdministrationProcess.SignDatabaseWithServerID( server$ , dbfile$ [ , updateonly ] )
UpgradeUserToHierarchical method noteID$ = notesAdministrationProcess.UpgradeUserToHierarchical( username$ [ , orgunit$ ] [ , altcommonname$ ] [ , altorgunit$ ] [ , altlanguage$ ] )
NotesAgent Class
Properties:
Comment property comment$ = notesAgent.Comment
CommonOwner property commonOwner$ = notesAgent.CommonOwner
HasRunSinceModified property flag = notesAgent.HasRunSinceModified
HttpURL property url$ = notesAgent.HttpURL
IsActivatable property flag = notesAgent.IsActivatable
IsEnabled property flag = notesAgent.IsEnabled
IsNotesAgent property flag = notesAgent.IsNotesAgent
IsPublic property flag = notesAgent.IsPublic
IsWebAgent property flag = notesAgent.IsWebAgent
LastRun property dateV = notesAgent.LastRun
LockHolders property lockHolders = notesAgent.LockHolders
Name property agentName$ = notesAgent.Name
NotesURL property url$ = notesAgent.NotesURL
OnBehalfOf property name$ = notesAgent.OnBehalfOf
Owner property ownerName$ = notesAgent.Owner
ParameterDocID property paramid$ = notesAgent.
Parent property Set notesDatabase = notesAgent.Parent
Query property query$ = notesAgent.Query
ServerName property server$ = notesAgent.ServerName
Target property flagIntegerConstant = notesAgent.Target
Trigger property flagIntegerConstant = notesAgent.Trigger
Methods:
Lock method flag = notesAgent.Lock( [ name ] [ , provisionalOK ] )
LockProvisional method flag = notesAgent.LockProvisional( [ name ] )
Remove method Call notesAgent.Remove
Run method status = notesAgent.Run( [ noteID$ ] )
RunOnServer method status = notesAgent.RunOnServer( [ noteID$ ] )
Save method Call notesAgent.Save
Unlock method Call notesAgent.Unlock( )
NotesColorObject Class
Properties:
Blue property valueRGB% = notesColorObject.Blue
Green property valueRGB% = notesColorObject.Green
Hue property valueHSL% = notesColorObject.Hue
Luminance property valueHSL% = notesColorObject.Luminance
NotesColor property notesColor% = notesColorObject.NotesColor
Red property valueRGB% = notesColorObject.Red
Saturation property valueHSL% = notesColorObject.Saturation
Methods:
SetHSL method notesColor% = notesColorObject.SetHSL( hue%, saturation%, luminance% )
SetRGB method notesColor% = notesColorObject.SetRGB( red%, green%, blue% )
NotesDatabase Class
Properties:
ACL property Set notesACL = notesDatabase.ACL
ACLActivityLog property stringArray = notesDatabase.ACLActivityLog
Agents property notesAgentArray = notesDatabase.Agents
AllDocuments property Set notesDocumentCollection = notesDatabase.AllDocuments
Categories property categoryList = notesDatabase.Categories
Created property dateV = notesDatabase.Created
CurrentAccessLevel property level% = notesDatabase.CurrentAccessLevel
DelayUpdates property flag = notesDatabase.DelayUpdates
DesignTemplateName property name$ = notesDatabase.DesignTemplateName
FileFormat property fileFormat% = notesDatabase.FileFormat
FileName property fileName$ = notesDatabase.FileName
FilePath property path$ = notesDatabase.FilePath
FolderReferencesEnabled property flag = notesDatabase.FolderReferencesEnabled
Forms property notesForm Array = notesDatabase.Forms
FTIndexFrequency property frequency% = notesDatabase.FTIndexFrequency
HttpURL property url$ = notesDatabase.HttpURL
IsClusterReplication property flag = notesDatabase.IsClusterReplication
IsConfigurationDirectory property flag = notesDatabase.IsConfigurationDirectory
IsCurrentAccessPublicReader property flag = notesDatabase.IsCurrentAccessPublicReader
IsCurrentAccessPublicWriter property flag = notesDatabase.IsCurrentAccessPublicWriter
IsDesignLockingEnabled property flag = notesDatabase.IsDesignLockingEnabled
IsDirectoryCatalog property flag = notesDatabase.IsDirectoryCatalog
IsDocumentLockingEnabled property flag = notesDatabase.IsDocumentLockingEnabled
IsFTIndexed property flag = notesDatabase.IsFTindexed
IsInMultiDbIndexing property flag = notesDatabase.IsInMultiDbIndexing
IsInService property flag = notesDatabase.IsInService
IsLink property flag = notesDatabase.IsLink
IsMultiDbSearch property flag = notesDatabase.IsMultiDbSearch
IsOpen property flag = notesDatabase.IsOpen
IsPendingDelete property flag = notesDatabase.IsPendingDelete
IsPrivateAddressBook property flag = notesDatabase.IsPrivateAddressBook
IsPublicAddressBook property flag = notesDatabase.IsPublicAddressBook
LastFixup property dateV = notesDatabase.LastFixup
LastFTIndexed property dateV = notesDatabase.LastFTIndexed
LastModified property dateV = notesDatabase.LastModified
LimitRevisions property revisions# = notesDatabase.LimitRevisions
LimitUpdatedBy property revisions# = notesDatabase.LimitUpdatedBy
ListInDbCatalog property flag = notesDatabase.ListInDbCatalog
Managers property stringArray = notesDatabase.Managers
MaxSize property size = notesDatabase.MaxSize
NotesURL property url$ = notesDatabase.NotesURL
Parent property Set notesSession = notesDatabase.Parent
PercentUsed property used# = notesDatabase.PercentUsed
ReplicaID property id$ = notesDatabase.ReplicaID
ReplicationInfo property Set notesReplication = notesDatabase.ReplicationInfo
Server property serverName$ = notesDatabase.Server
Size property size# = notesDatabase.Size
SizeQuota property quota& = notesDatabase.SizeQuota
SizeWarning property warning% = notesDatabase.SizeWarning
TemplateName property name$ = notesDatabase.TemplateName
Title property title$ = notesDatabase.Title
Type property type% = notesDatabase.Type
UndeleteExpireTime property hours% = notesDatabase.UndeleteExpireTime
UnprocessedDocuments property Set notesDocumentCollection = notesDatabase.UnprocessedDocuments
Views property notesViewArray = notesDatabase.Views
Methods:
Compact method sizeDelta& = notesDatabase.Compact
CompactWithOptions method sizeDelta& = notesDatabase.CompactWithOptions( options$ )
Create method Call notesDatabase.Create( server$, dbfile$, openFlag [, maxsize% ] )
CreateCopy method Set notesDatabaseNew = notesDatabase.CreateCopy( newServer$, newDbFile$ [, maxsize% ] )
CreateDocument method Set notesDocument = notesDatabase.CreateDocument
CreateFromTemplate method Set notesDatabaseNew = notesDatabase.CreateFromTemplate( newServer$, newDbFile$, inheritFlag [, maxsize% ] )
CreateFTIndex method Call notesDatabase.CreateFTIndex( options& , recreate )
CreateNoteCollection method Set notesNoteCollection = notesDatabase.CreateNoteCollection( selectAllFlag )
CreateOutline method Set notesOutline = notesDatabase.CreateOutline( outlinename$ [, defaultOutline ] )
CreateReplica method Set notesDatabaseReplica = notesDatabase.CreateReplica( newServer$, newDbFile$ )
CreateView method Set notesView = notesDatabase.CreateView( [ viewName$ ] , [ viewSelectionFormula$ ] , [ templateView ] , [ prohibitDesignRefreshModifications ] )
EnableFolder method Call notesDatabase.EnableFolder( foldername$ )
Fixup method Call notesDatabase.Fixup( [ options& ] )
FTDomainSearch method Set notesDocument = notesDatabase.FTDomainSearch( query$, maxDocs%, [ sortoptions%], [ otheroptions%], [ start&], [ count%], [ entryform$ ] )
FTSearch method Set notesDocumentCollection = notesDatabase.FTSearch( query$, maxdocs%, [ sortoptions% ], [ otheroptions% ] )
FTSearchRange method Set notesDocumentCollection = notesDatabase.FTSearchRange( query$, maxdocs%, [ sortoptions% ], [ otheroptions% ], [ start&] )
GetAgent method Set notesAgent = notesDatabase.GetAgent( agentName$ )
GetDocumentByID method Set notesDocument = notesDatabase.GetDocumentByID( noteID$ )
GetDocumentByUNID method Set notesDocument = notesDatabase.GetDocumentByUNID( unid$ )
GetDocumentByURL method Set notesDocument = notesDatabase.GetDocumentByURL( URL$ [, reload ] [, urllist ] [, charset$ ] [, webusername$ ] [, webpassword$ ] [, proxywebusername$ ] [, proxywebpassword$ ] [, returnimmediately ] )
GetForm method Set notesForm = notesDatabase.GetForm( name$ )
GetOption method flag = notesDatabase.GetOption( optionName% )
GetOutline method Set notesOutline = notesDatabase.GetOutline( outlinename$ )
GetProfileDocCollection method Set notesDocumentCollection = notesDatabase.GetProfileDocCollection( profilename$ )
GetProfileDocument method Set notesDocument = notesDatabase.GetProfileDocument( profilename$ [, uniqueKey$ ] )
GetURLHeaderInfo method header$ = notesDatabase.GetURLHeaderInfo( URL$ , headername$ [, Webusername$ ] [, Webpassword$ ] [, Proxywebusername$ ] [, Proxywebpassword$ ] )
GetView method Set notesView = notesDatabase.GetView( viewName$ )
GrantAccess method Call notesDatabase.GrantAccess( name$, level% )
MarkForDelete method Call notesDatabase.MarkForDelete( )
Open method Note The following syntax is for LotusScript. flag = notesDatabase.Open( server$, dbfile$ )
OpenByReplicaID method flag = notesDatabase.OpenByReplicaID( server$, replicaID$ )
OpenIfModified method flag = notesDatabase.OpenIfModified( server$, dbfile$, notesDateTime )
OpenMail method Call notesDatabase.OpenMail
OpenURLDb method flag = notesDatabase.OpenURLDb
OpenWithFailover method flag = notesDatabase.OpenWithFailover( server$, dbfile$ )
QueryAccess method level% = notesDatabase.QueryAccess( name$ )
QueryAccessRoles method roles = notesDatabase.QueryAccessRoles( name$ )
Remove method Call notesDatabase.Remove
RemoveFTIndex method Call notesDatabase.RemoveFTIndex( )
Replicate method flag = notesDatabase.Replicate( serverName$ )
RevokeAccess method Call notesDatabase.RevokeAccess( name$ )
Search method Set notesDocumentCollection = notesDatabase.Search( formula$, notesDateTime, maxDocs% )
SetOption method Call notesDatabase.SetOption( optionName% , flag )
Sign method Call notesDatabase.Sign( [ documentType% ] [ , existingSigsOnly ] [ , nameStr$] [ , nameStrIsNoteID ] )
UnprocessedFTSearch method Set notesDocumentCollection = notesDatabase.UnprocessedFTSearch(query$, maxdocs%, [ sortoptions% ], [ otheroptions% ] )
UnprocessedFTSearchRange method Set notesDocumentCollection = notesDatabase.UnprocessedFTSearchRange( query$, maxdocs%, [ sortoptions% ], [ otheroptions% ], [ start&] )
UnprocessedSearch method Set notesDocumentCollection = notesDatabase.UnprocessedSearch( formula$, notesDateTime, maxDocs% )
UpdateFTIndex method Call notesDatabase.UpdateFTIndex( createFlag )
NotesDateRange Class
Properties:
EndDateTime property notesDateTime = notesDateRange.EndDateTime
Parent property Set notesSession = notesDateRange.Parent
StartDateTime property notesDateTime = notesDateRange.StartDateTime
Text property text = notesDateRange.Text
Notesdatetime Class
Properties:
DateOnly property date$ = notesDateTime.DateOnly
GMTTime property gmt$ = notesDateTime.GMTTime
IsDST property flag = notesDateTime.IsDST
IsValidDate property flag = notesDateTime.IsValidDate
LocalTime property time$ = notesDateTime.LocalTime
LSGMTTime property gmtV = notesDateTime.LSGMTTime Example See Also GMTTime property
LSLocalTime property timeV = notesDateTime.LSLocalTime
Parent property Set notesSession = notesDateTime.Parent
TimeOnly property time$ = notesDateTime.TimeOnly
TimeZone property zone% = notesDateTime.TimeZone
ZoneTime property zone$ = notesDateTime.ZoneTime
Methods:
AdjustDay method Call notesDateTime.AdjustDay( n% [, preserveLocalTime ] )
AdjustHour method Call notesDateTime.AdjustHour( n% [, preserveLocalTime ] )
AdjustMinute method Call notesDateTime.AdjustMinute( n% [, preserveLocalTime ] )
AdjustMonth method Call notesDateTime.AdjustMonth( n% [ , preserveLocalTime ] )
AdjustSecond method Call notesDateTime.AdjustSecond( n% [, preserveLocalTime ] )
AdjustYear method Call notesDateTime.AdjustYear( n% [, preserveLocalTime ] )
ConvertToZone method Call notesDateTime.ConvertToZone( newzone, dst )
SetAnyDate method Call notesDateTime.SetAnyDate
SetAnyTime method Call notesDateTime.SetAnyTime
SetNow method Call notesDateTime.SetNow
TimeDifference method difference& = notesDateTime.TimeDifference( notesDateTime )
TimeDifferenceDouble method difference# = notesDateTime.TimeDifferenceDouble( notesDateTime )
NotesDbDirectory Class
Properties:
Name property serverName$ = notesDbDirectory.Name
Parent property Set notesSession = notesDbDirectory.Parent
Methods:
CreateDatabase method Set notesDatabase = notesDbDirectory.CreateDatabase( dbfile$ [ , open ] )
GetFirstDatabase method Set notesDatabase = notesDbDirectory.GetFirstDatabase( fileType% )
GetNextDatabase method Set notesDatabase = notesDbDirectory.GetNextDatabase
OpenDatabase method Set notesDatabase = notesDbDirectory.OpenDatabase( dbfile$ [ , failover ] )
OpenDatabaseByReplicaID method Set notesDatabase = notesDbDirectory.OpenDatabaseByReplicaID( rid$ )
OpenDatabaseIfModified method Set notesDatabase = notesDbDirectory.OpenDatabaseIfModified( dbfile$ , notesDateTime )
OpenMailDatabase method Set notesDatabase = notesDbDirectory.OpenMailDatabase( )
NotesDocument Class
Properties:
Authors property authorArray = notesDocument.Authors
ColumnValues property valueArray = notesDocument.ColumnValues
Created property dateV = notesDocument.Created
EmbeddedObjects property notesEmbeddedObjectArray = notesDocument.EmbeddedObjects
EncryptionKeys property stringArray = notesDocument.EncryptionKeys
EncryptOnSend property flag = notesDocument.EncryptOnSend
FolderReferences property StringArray = notesDocument.FolderReferences
FTSearchScore property score% = notesDocument.FTSearchScore
HasEmbedded property flag = notesDocument.HasEmbedded
HttpURL property url$ = notesDocument.HttpURL
IsDeleted property flag = notesDocument.IsDeleted
IsEncrypted property flag = notesDocument.IsEncrypted
IsNewNote property flag = notesDocument.IsNewNote
IsProfile property flag = notesDocument.IsProfile
IsResponse property flag = notesDocument.IsResponse
IsSigned property flag = notesDocument.IsSigned
IsUIDocOpen property flag = notesDocument.IsUIDocOpen
IsValid property flag = notesDocument.IsValid
Items property notesItemArray = notesDocument.Items
Key property string$ = notesDocument.Key
LastAccessed property dateV = notesDocument.LastAccessed
LastModified property dateV = notesDocument.LastModified
LockHolders property lockHolders = notesDocument.LockHolders
NameOfProfile property To get string = notesDocument.NameOfProfile
NoteID property noteid$ = notesDocument.NoteID
NotesURL property url$ = notesDocument.NotesURL
ParentDatabase property Set notesDatabase = notesDocument.ParentDatabase
ParentDocumentUNID property parentUnid$ = notesDocument.ParentDocumentUNID
ParentView property Set notesView = notesDocument.ParentView
Responses property Set notesDocumentCollection = notesDocument.Responses
SaveMessageOnSend property flag = notesDocument.SaveMessageOnSend
SentByAgent property flag = notesDocument.SentByAgent
Signer property signer$ = notesDocument.Signer
SignOnSend property flag = notesDocument.SignOnSend
Size property size& = notesDocument.Size
UniversalID property unid$ = notesDocument.UniversalID
Verifier property verifier$ = notesDocument.Verifier
Methods:
AppendItemValue method Set notesItem = notesDocument.AppendItemValue( itemName$, value )
CloseMIMEEntities method flag = notesDocument.CloseMIMEEntities( [ savechanges [, entityitemname$ ] ] )
ComputeWithForm method flag = notesDocument.ComputeWithForm( doDataTypes, raiseError )
CopyAllItems method Call notesDocument.CopyAllItems( notesDocument [, replace ] )
CopyItem method Set notesItem = notesDocument.CopyItem( item, newName$ )
CopyToDatabase method Set newNotesDocument = notesDocument.CopyToDatabase( notesDatabase )
CreateMIMEEntity method Set notesMIMEEntity = notesDocument.CreateMIMEEntity( [ itemName$ ] )
CreateReplyMessage method Set replyNotesDocument = notesDocument.CreateReplyMessage( all )
CreateRichTextItem method Set notesRichTextItem = notesDocument.CreateRichTextItem( name$ )
Encrypt method Call notesDocument.Encrypt
GetAttachment method Set notesEmbeddedObject = notesDocument.GetAttachment( fileName$ )
GetFirstItem method Set notesItem = notesDocument.GetFirstItem( name$ )
GetItemValue method valueArray = notesDocument.GetItemValue( itemName$ )
GetItemValueDateTimeArray method notesDateTimeArray = notesDocument.GetItemValueDateTime( itemName$ )
GetMIMEEntity method Set notesMIMEEntity = notesDocument.GetMIMEEntity( [ itemName$ ] )
GetReceivedItemText method stringArray = notesDocument.GetReceivedItemText( )
HasItem method flag = notesDocument.HasItem( itemName$ )
Lock method flag = notesDocument.Lock( [ name ] [, provisionalOK ] )
LockProvisional method flag = notesDocument.LockProvisional( [ name ] )
MakeResponse method Call notesDocument.MakeResponse( document )
PutInFolder method Call notesDocument.PutInFolder( folderName$ [, createonfail ] )
Remove method flag = notesDocument.Remove( force )
RemoveFromFolder method Call notesDocument.RemoveFromFolder( folderName$ )
RemoveItem method Call notesDocument.RemoveItem( itemName$ )
RemovePermanently method flag = notesDocument.RemovePermanently( force )
RenderToRTItem method flag = notesDocument.RenderToRTItem( notesRichTextItem )
ReplaceItemValue method Set notesItem = notesDocument.ReplaceItemValue( itemName$, value )
Save method flag = notesDocument.Save( force, createResponse [, markRead ] )
Send method Call notesDocument.Send( attachForm [, recipients ] )
Sign method Call notesDocument.Sign
Unlock method Call notesDocument.Unlock( )
NotesDocumentcollection Class
Properties:
Count property numDocs& = notesDocumentCollection.Count
IsSorted property flag = notesDocumentCollection.IsSorted
Parent property Set notesDatabase = notesDocumentCollection.Parent
Query property query$ = notesDocumentCollection.Query
Methods:
AddDocument method Call notesDocumentCollection.AddDocument( document [, checkDups ] )
DeleteDocument method Call notesDocumentCollection.DeleteDocument( document )
FTSearch method Call notesDocumentCollection.FTSearch( query$, maxDocs% )
GetDocument method Set notesDocument = notesDocumentCollection.GetDocument( document )
GetFirstDocument method Set notesDocument = notesDocumentCollection.GetFirstDocument
GetLastDocument method Set notesDocument = notesDocumentCollection.GetLastDocument
GetNextDocument method Set notesDocument = notesDocumentCollection.GetNextDocument( document )
GetNthDocument method Set notesDocument = notesDocumentCollection.GetNthDocument( n% )
GetPrevDocument method Set notesDocument = notesDocumentCollection.GetPrevDocument( document )
PutAllInFolder method Call notesDocumentCollection.PutAllInFolder( folderName$ [, createonfail ] )
RemoveAll method Call notesDocumentCollection.RemoveAll( force )
RemoveAllFromFolder method Call notesDocumentCollection.RemoveAllFromFolder( folderName$ )
StampAll method Call notesDocumentCollection.StampAll( itemname, value )
UpdateAll method Call notesDocumentCollection.UpdateAll
NotesDOMAattributenode Class
Properties:
AttributeName property attributeName$ = notesDOMAttributeNode.AttributeName
AttributeValue property value$ = notesDOMAttributeNode.AttributeValue To set: notesDOMAttributeNode.AttributeValue = value$
IsSpecified property flag = noteDOMAttributeNode.IsSpecified
NotesDOMCharacterdatanode Class
Methods:
AppendData method Call notesDOMCharacterDataNode.AppendData( appendText )
DeleteData method Call notesDOMCharacterDataNode.DeleteData( offset, count )
InsertData method Call notesDOMCharacterDataNode.InsertData( offset, newText )
ReplaceData method Call notesDOMCharacterDataNode.ReplaceData( offset, count, replacementText )
SubstringData method newString$ = notesDOMCharacterDataNode.SubstringData( offset , count )
NotesDOMDocumentNode Class
Properties:
DocumentElement property Set notesDOMElementNode = notesDOMElementNode.DocumentElement
Methods:
CreateAttributeNode method Set notesDOMAttributeNode = notesDOMDocumentNode.CreateAttributeNode( attributeName )
CreateCDATASectionNode method Set notesDOMCDATASectionNode = notesDOMDocumentNode.CreateCDATASectionNode( cdataSection )
CreateCommentNode method Set notesDOMCommentNode = notesDOMDocumentNode.CreateCommentNode( comment )
CreateDocumentFragmentNode method Set notesDOMDocumentFragmentNode = notesDOMDocumentNode.CreateDocumentFragmentNode( )
CreateDocumentNode method Set notesDOMDocumentNode = notesDOMDocumentNode.CreateDocumentNode( )
CreateElementNode method Set notesDOMElementNode = notesDOMDocumentNode.CreateElementNode( elementName )
CreateEntityReferenceNode method Set notesDOMEntityReferenceNode = notesDOMDocumentNode.CreateEntityReferenceNode( entityReferenceName )
CreateNotationNode method Set notesDOMNotationNode = notesDOMDocumentNode.CreateNotationNode( notationName$ )
CreateProcessingInstructionNode method Set notesDOMProcessingInstructionNode = notesDOMDocumentNode.CreateProcessingInstructionNode( target , data )
CreateTextNode method Set notesDOMTextNode = notesDOMDocumentNode.CreateTextNode( text )
CreateXMLDeclNode method Set notesDOMXMLDeclNode = notesDOMDocumentNode.CreateXMLDeclNode( version$ , encoding$ , standalone$ )
GetElementsByTagName method Set notesDOMNodeList = notesDOMDocument.GetElementsByTagName( elementName )
NotesDOMElementnode Class
Properties:
TagName property tagName$ = notesDOMElementNode.TagName
Methods:
GetAttribute method attr$ = notesDOMElementNode.GetAttribute( attributeName )
GetAttributeNode method Set notesDOMAttributeNode = notesDOMElementNode.GetAttributeNode( attributeName )
GetElementsByTagName method Set notesDOMNodeList = notesDOMElementNode.GetElementsByTagName( tagName )
RemoveAttribute method Call notesDOMElementNode.RemoveAttribute( attributeName )
RemoveAttributeNode method Set notesDOMAttributeNode = notesDOMElementNode.RemoveAttributeNode( attributenode )
SetAttribute method Call notesDOMElementNode.SetAttribute( attributeName, attributeValue )
SetAttributeNode method Set notesDOMAttributeNode = notesDOMElementNode.SetAttributeNode( attributeNode )
Notesdomnamednodemap Class
Properties:
NumberOfEntries property nEntries& = notesDOMNamedNodeMap.NumberOfEntries Example
Methods:
GetItem method Set notesDOMNode = notesDOMNamedNodeMap.GetItem( index& )
NotesDOMnode Class
Properties:
Attributes property Set notesDOMNamedNodeMap = notesDOMNode.Attributes
FirstChild property Set notesDOMNode = notesDOMNode.FirstChild
HasChildNodes property flag = notesDOMNode.HasChildNodes
IsNull property flag = notesDOMNode.IsNull
LastChild property Set notesDOMNode = notesDOMNode.LastChild
LocalName property localName$ = notesDOMNode.LocalName
NamespaceURI property nameSpaceURI$ = notesDOMNode.NamespaceURI
NextSibling property Set notesDOMNode = notesDOMNode.NextSibling
NodeName property nodeName$ = notesDOMNode.NodeName
NodeType property nodeType& = notesDOMNode.NodeType
NodeValue property nodeValue$ = notesDOMNode.NodeValue
NumberOfChildNodes property number& = notesDOMNode.NumberOfChildNodes Example
ParentNode property Set notesDOMNode = notesDOMNode.ParentNode
Prefix property prefix$ = notesDOMNode.Prefix
PreviousSibling property Set notesDOMNode = notesDOMNode.PreviousSibling
Methods:
AppendChild method Set notesDOMNode = notesDOMNode.AppendChild( newChild )
Clone method Set notesDOMNode = notesDOMNode.Clone( deepClone )
RemoveChild method Set notesDOMNode = notesDOMNode.RemoveChild( child )
ReplaceChild method Set notesDOMNode = notesDOMNode.ReplaceChild( newChild, oldChild )
NotesDOMnodelist Class
Properties:
NumberOfEntries property nEntries& = notesDOMNodeList.NumberOfEntries Example
Methods:
GetItem method Set notesDOMNode = notesDOMNodeList.GetItem( index& )
NotesDOMnotationnode Class
Properties:
PublicID property To get id$ = notesDOMNotationNode.PublicID
SystemID property id$ = notesDOMNotationNode.SystemID
NotesDOMparser Class
Properties:
AddXMLDeclNode property flag = notesDOMParser.AddXMLDeclNode
Document property Set notesDOMDocumentNode = notesDOMParser.Document
DoNamespaces property flag = notesDOMParser.DoNamespaces
ExpandEntityReferences property flag = notesDOMParser.ExpandEntityReferences
InputValidationOption property option% = notesDOMParser.InputValidationOption
Methods:
Output method Call notesDomParser.Output( outputText )
Serialize method Call notesDomParser.Serialize( )
Events:
PostDOMParse event PostDOMParse( Source As NotesDOMParser )
NotesDOMprocessinginstructionnode Class
Properties:
Data property data$ = notesDOMProcessingInstructionNode.Data
Target property target$ = notesDOMProcessingInstructionNode.Target
NotesDOMTextnode Class
Methods:
SplitText method Set notesDOMTextNode = notesDOMTextNode.SplitText( offset )
NotesDOMXMLdeclnode Class
Properties:
Encoding property encode$ = notesDOMXMLDeclNode.Encoding
Standalone property flag$ = notesDOMXMLDeclNode.Standalone
Version property version$ = notesDOMXMLDeclNode.Version
NotesDXLexporter Class
Properties:
DoctypeSYSTEM property system$ = notesDXLExporter.DoctypeSYSTEM
ForceNoteFormat property flag = notesDXLExporter.ForceNoteFormat
OutputDOCTYPE property flag = notesDXLExporter.OutputDOCTYPE
NotesDXLimporter Class
Properties:
ACLImportOption property option% = notesDXLImporter.ACLImportOption
CreateFTIndex property flag = notesDXLImporter.CreateFTIndex
DesignImportOption property option% = notesDXLImporter.DesignImportOption
DocumentImportOption property option% = notesDXLImporter.DocumentImportOption
ImportedNoteCount property count& = notesDXLImporter.ImportedNoteCount
InputValidationOption property option% = notesDXLImporter.InputValidationOption
ReplaceDbProperties property flag = notesDXLImporter.ReplaceDbProperties
ReplicaRequiredForReplaceOrUpdate property flag = notesDXLImporter.ReplicaRequiredForReplaceOrUpdate
UnknownTokenLogOption property flag = notesDXLImporter.UnknownTokenLogOption
Methods:
GetFirstImportedNoteID method noteID$ = notesDXLImporter.GetFirstImportedNoteID( )
GetNextImportedNoteID method nextNoteID$ = notesDXLImporter.GetNextImportedNoteID( noteID$ )
NotesEmbeddedObject Class
Properties:
Class property className$ = notesEmbeddedObject.Class
FileSize property size& = notesEmbeddedObject.FileSize
FitBelowFields property flag = notesEmbeddedObject.FitBelowFields
FitToWindow property flag = notesEmbeddedObject.FitToWindow
Name property name$ = notesEmbeddedObject.Name
Object property Set handleV = notesEmbeddedObject.Object
Parent property Set notesRichTextItem = notesEmbeddedObject.Parent
RunReadOnly property flag = notesEmbeddedObject.RunReadOnly
Source property source$ = notesEmbeddedObject.Source
Type property type% = notesEmbeddedObject.Type
Verbs property stringArray = notesEmbeddedObject.Verbs
Methods:
Activate method Set handleV = notesEmbeddedObject.Activate( show )
DoVerb method variant = notesEmbeddedObject.DoVerb( verb$ )
ExtractFile method Call notesEmbeddedObject.ExtractFile( path$ )
Remove method Call notesEmbeddedObject.Remove
NotesForm Class
Properties:
Aliases property stringArray = notesForm.Aliases
Fields property stringArray = notesForm.Fields
FormUsers property stringArray = notesForm.FormUsers
HttpURL property url$ = notesForm.HttpURL
IsSubForm property flag = notesForm.IsSubForm
LockHolders property lockHolders = notesForm.LockHolders
Name property string = notesForm.Name
NotesURL property url$ = notesForm.NotesURL
Parent property Set notesDatabase = notesForm.Parent
ProtectReaders property flag = notesForm.ProtectReaders
ProtectUsers property flag = notesForm.ProtectUsers
Readers property stringArray = notesForm.Readers
Methods:
GetFieldType method type% = notesForm.GetFieldType( name )
Lock method flag = notesForm.Lock( [ name ] [ , provisionalOK ] )
LockProvisional method flag = notesForm.LockProvisional( [ name ] )
Remove method Call notesForm.Remove
Unlock method Call notesForm.Unlock( )
NotesInternational Class
Properties:
AMString property string = notesInternational.AMString
CurrencyDigits property flag = notesInternational.CurrencyDigits
CurrencySymbol property string = notesInternational.CurrencySymbol
DateSep property string = notesInternational.DateSep
DecimalSep property string = notesInternational.DecimalSep
IsCurrencySpace property flag = notesInternational.IsCurrencySpace
IsCurrencySuffix property flag = notesInternational.IsCurrencySuffix
IsCurrencyZero property flag = notesInternational.IsCurrencyZero
IsDateDMY property flag = notesInternational.IsDateDMY
IsDateMDY property flag = notesInternational.IsDateMDY
IsDateYMD property flag = notesInternational.IsDateYMD
IsDST property flag = notesInternational.IsDST
IsTime24Hour property flag = notesInternational.IsTime24Hour
Parent property Set notesSession = notesInternational.Parent
PMString property string = notesInternational.PMString
ThousandsSep property string = notesInternational.ThousandsSep
TimeSep property string = notesInternational.TimeSep
TimeZone property zone% = notesInternational.TimeZone
Today property string = notesInternational.Today
Tomorrow property string = notesInternational.Tomorrow
Yesterday property string = notesInternational.Yesterday
NotesItem Class
Properties:
DateTimeValue property Set notesDateTime = notesItem.DateTimeValue
IsAuthors property flag = notesItem.IsAuthors
IsEncrypted property flag = notesItem.IsEncrypted
IsNames property flag = notesItem.IsNames
IsProtected property flag = notesItem.IsProtected
IsReaders property flag = notesItem.IsReaders
IsSigned property flag = notesItem.IsSigned
IsSummary property flag = notesItem.IsSummary
LastModified property dateV = notesItem.LastModified
Name property itemName$ = notesItem.Name
Parent property Set notesDocument = notesItem.Parent
SaveToDisk property flag = notesItem.SaveToDisk
Text property itemText$ = notesItem.Text
Type property itemType% = notesItem.Type
ValueLength property size% = notesItem.ValueLength
Values property valueArray = notesItem.Values
Methods:
Abstract method abbreviation$ = notesItem.Abstract( maxAbstract&, dropVowels, useDictionary )
AppendToTextList method Call notesItem.AppendToTextList( newValue )
Contains method flag = notesItem.Contains( value )
CopyItemToDocument method Set notesItem = notesItem.CopyItemToDocument( document, newName$ )
GetMIMEEntity method Set notesMIMEEntity = notesItem.GetMIMEEntity
GetValueDateTimeArray method notesDateTimeArray = notesItem.GetValueDateTime( )
Remove method Call notesItem.Remove
NotesLog Class
Properties:
LogActions property flag = notesLog.LogActions
LogErrors property flag = notesLog.LogErrors
NumActions property actions% = notesLog.NumActions
NumErrors property errors% = notesLog.NumErrors
OverwriteFile property flag = notesLog.OverwriteFile
Parent property Set notesSession = notesLog.Parent
ProgramName property programName$ = notesLog.ProgramName
Methods:
Close method Call notesLog.Close
LogAction method Call notesLog.LogAction( description$ )
LogError method Call notesLog.LogError( code%, description$ )
LogEvent method Call notesLog.LogEvent( message$, queuename$, type%, severity% )
OpenAgentLog method Call notesLog.OpenAgentLog
OpenFileLog method Call notesLog.OpenFileLog( path$ )
OpenMailLog method Call notesLog.OpenMailLog( recipientsV, subject$ )
OpenNotesLog method Call notesLog.OpenNotesLog( server$, dbfile$ )
NotesMIMEheader Class
Properties:
HeaderName property headerName$ = notesMIMEHeader.HeaderName
Methods:
AddValText method flag = notesMIMEHeader.AddValText( valueText [ , charSet ] )
GetHeaderVal method headerValue$ = notesMIMEHeader.GetHeaderVal( [ folded ] , [ decoded ] )
GetHeaderValAndParams method headerAndParams$ = notesMIMEHeader.GetHeaderValAndParams( [ folded ] , [ decoded ] )
GetParamVal method parameterValue$ = notesMIMEHeader.GetParamVal( paramName$ [ , folded ] )
Remove method Call notesMIMEHeader.Remove()
SetHeaderVal method flag = notesMIMEHeader.SetHeaderVal( headerValue$ )
SetHeaderValAndParams method flag = notesMIMEHeader.SetHeaderValAndParams( headerParamValue$ )
SetParamVal method flag = notesMIMEHeader.SetParamVal( parameterName$ , parameterValue$ )
NotesName Class
Properties:
Abbreviated property string$ = notesName.Abbreviated
Addr821 property string$ = notesName.Addr821
Addr822Comment1 property string$ = notesName.Addr822Comment1
Addr822Comment2 property string$ = notesName.Addr822Comment2
Addr822Comment3 property string$ = notesName.Addr822Comment3
Addr822LocalPart property string$ = notesName.Addr822LocalPart
Addr822Phrase property string$ = notesName.Addr822Phrase
ADMD property string$ = notesName.ADMD
Canonical property string$ = notesName.Canonical
Common property string$ = notesName.Common
Country property string$ = notesName.Country
Generation property string$ = notesName.Generation
Given property string$ = notesName.Given
Initials property string$ = notesName.Initials
IsHierarchical property flag = notesName.IsHierarchical
Keyword property string$ = notesName.Keyword
Language property string$ = notesName.Language
Organization property string$ = notesName.Organization
OrgUnit1 property string$ = notesName.OrgUnit1
OrgUnit2 property string$ = notesName.OrgUnit2
OrgUnit3 property string$ = notesName.OrgUnit3
OrgUnit4 property string$ = notesName.OrgUnit4
Parent property Set notesSession = notesName.Parent
PRMD property string$ = notesName.PRMD
Surname property string$ = notesName.Surname
NotesNewsletter Class
Properties:
DoScore property flag = notesNewsletter.DoScore
DoSubject property flag = notesNewsletter.DoSubject
Parent property Set notesSession = notesNewsletter.Parent
SubjectItemName property name$ = notesNewsletter.SubjectItemName
Methods:
FormatDocument method Set notesDocument = notesNewsletter.FormatDocument( notesDatabase, n% )
FormatMsgWithDoclinks method Set notesDocument = notesNewsletter.FormatMsgWithDoclinks( notesDatabase )
NotesNoteCollection Class
Properties:
Count property count& = notesNoteCollection.Count Example See Also Building a Note Collection
LastBuildTime property lastBuildTime = notesNoteCollection.LastBuildTime
Parent property Set notesDatabase = notesNoteCollection.Parent See Also Building a Note Collection
SelectACL property flag = notesNoteCollection.SelectACL
SelectActions property flag = notesNoteCollection.SelectActions
SelectAgents property flag = notesNoteCollection.SelectAgents
SelectDatabaseScript property flag = notesNoteCollection.SelectDatabaseScript
SelectDataConnections property flag = notesNoteCollection.SelectDataConnections
SelectDocuments property flag = notesNoteCollection.SelectDocuments
SelectFolders property flag = notesNoteCollection.SelectFolders
SelectForms property flag = notesNoteCollection.SelectForms
SelectFrameSets property flag = notesNoteCollection.SelectFrameSets
SelectHelpAbout property flag = notesNoteCollection.SelectHelpAbout
SelectHelpIndex property flag = notesNoteCollection.SelectHelpIndex
SelectHelpUsing property flag = notesNoteCollection.SelectHelpUsing
SelectIcon property flag = notesNoteCollection.SelectIcon
SelectImageResources property flag = notesNoteCollection.SelectImageResources
SelectionFormula property formula$ = notesNoteCollection.SelectionFormula
SelectJavaResources property flag = notesNoteCollection.SelectJavaResources
SelectMiscCodeElements property flag = notesNoteCollection.SelectMiscCodeElements
SelectMiscFormatElements property flag = notesNoteCollection.SelectMiscFormatElements
SelectMiscIndexElements property flag = notesNoteCollection.SelectMiscIndexElements
SelectNavigators property flag = notesNoteCollection.SelectNavigators
SelectOutlines property flag = notesNoteCollection.SelectOutlines
SelectPages property flag = notesNoteCollection.SelectPages
SelectProfiles property flag = notesNoteCollection.SelectProfiles
SelectReplicationFormulas property flag = notesNoteCollection.SelectReplicationFormulas
SelectScriptLibraries property flag = notesNoteCollection.SelectScriptLibraries
SelectSharedFields property flag = notesNoteCollection.SelectSharedFields
SelectStyleSheetResources property flag = notesNoteCollection.SelectStyleSheetResources
SelectSubforms property flag = notesNoteCollection.SelectSubforms
SelectViews property flag = notesNoteCollection.SelectViews
SinceTime property sinceTime = notesNoteCollection.SinceTime
Methods:
Add method Call notesNoteCollection.Add( additionSpecifier )
BuildCollection method Call notesNoteCollection.BuildCollection
ClearCollection method Call notesNoteCollection.ClearCollection
GetFirstNoteID method noteID$ = notesNoteCollection.GetFirstNoteID( )
GetNextNoteID method nextNoteID$ = notesNoteCollection.GetFirstNoteID( noteID$ )
Intersect method Call notesNoteCollection.Intersect( intersectionSpecifier )
Remove method Call notesNoteCollection.Remove( removalSpecifier )
SelectAllAdminNotes method Call notesNoteCollection.SelectAllAdminNotes( selectorValue )
SelectAllCodeElements method Call notesNoteCollection.SelectAllCodeElements( selectorValue )
SelectAllDataNotes method Call notesNoteCollection.SelectAllDataNotes( selectorValue )
SelectAllDesignElements method Call notesNoteCollection.SelectAllDesignElements( selectorValue )
SelectAllFormatElements method Call notesNoteCollection.SelectAllFormatElements( selectorValue )
SelectAllIndexElements method Call notesNoteCollection.SelectAllIndexElements( selectorValue )
SelectAllNotes method Call notesNoteCollection.SelectAllNotes( selectorValue )
NotesOutline Class
Properties:
Alias property alias$ = notesOutline.Alias
Comment property comment$ = notesOutline.Comment
Name property name$ = notesOutline.Name
ParentDatabase property Set notesDatabase = notesOutline.ParentDatabase
Methods:
AddEntry method Call notesOutline.AddEntry( newEntry [, refEntry ] [, moveAfter ] [, AsChild ] )
CreateEntry method Set notesOutlineEntry = notesOutline.CreateEntry( name$ [, refEntry ] [, addAfter ] [, asChild ] )
CreateEntryFrom method Set notesOutlineEntry = notesOutline.CreateEntryFrom( entry [, refentry ] [, addAfter ] [, asChild ] )
GetChild method Set notesOutlineEntry = notesOutline.GetChild( entry )
GetFirst method Set notesOutlineEntry = notesOutline.GetFirst( )
GetLast method Set notesOutlineEntry = notesOutline.GetLast( )
GetNext method Set notesOutlineEntry = notesOutline.GetNext( entry )
GetNextSibling method Set notesOutlineEntry = notesOutline.GetNextSibling( entry )
GetParent method Set notesOutlineEntry = notesOutline.GetParent( entry )
GetPrev method Set notesOutlineEntry = notesOutline.GetPrev( entry )
GetPrevSibling method Set notesOutlineEntry = notesOutline.GetPrevSibling( entry )
MoveEntry method Call notesOutline.MoveEntry( currentEntry, refEntry [, moveAfter ] [, AsChild ] )
RemoveEntry method Call notesOutline.RemoveEntry( currentEntry )
Save method Call notesOutline.Save( )
NotesOutlineEntry Class
Properties:
Alias property alias$ = notesOutlineEntry.Alias
Database property Set notesDatabase = notesOutlineEntry.Database
Document property Set notesDocument = notesOutlineEntry.Document
EntryClass property entryclass% = notesOutlineEntry.EntryClass
Formula property formula$ = notesOutlineEntry.Formula
FrameText property frame$ = notesOutlineEntry.FrameText
HasChildren property flag = notesOutlineEntry.HasChildren
HideFormula property image$ = notesOutlineEntry.HideFormula
ImagesText property image$ = notesOutlineEntry.ImagesText
IsHidden property flag = notesOutlineEntry.IsHidden
IsHiddenFromNotes property flag = notesOutlineEntry.IsHiddenFromNotes
IsHiddenFromWeb property flag = notesOutlineEntry.IsHiddenFromWeb
IsInThisDB property flag = notesOutlineEntry.IsInThisDB
IsPrivate property flag = notesOutlineEntry.IsPrivate
KeepSelectionFocus property flag = notesOutlineEntry.KeepSelectionFocus
Label property text$ = notesOutlineEntry.Label
Level property level& = notesOutlineEntry.Level
NamedElement property element$ = notesOutlineEntry.NamedElement
Parent property Set notesOutline = notesOutlineEntry.Parent
Type property entrytype& = notesOutlineEntry.Type
URL property url$ = notesOutlineEntry.URL
UseHideFormula property flag = notesOutlineEntry.UseHideFormula
View property Set notesView = notesOutlineEntry.View
Methods:
SetAction method flag = notesOutlineEntry.SetAction( formula$ )
SetNamedElement method flag = notesOutlineEntry.SetNamedElement( notesDatabase, elementName$, entryclass% )
SetNoteLink method Note The following syntax is for LotusScript. flag = notesOutlineEntry.SetNoteLink( notesDatabase, notesView, notesDocument )
SetURL method flag = notesOutlineEntry.SetURL( url$ )
NotesRegistration Class
Properties:
AltOrgUnit property stringArray = notesRegistration.AltOrgUnit
AltOrgUnitLang property stringArray = notesRegistration.AltOrgUnitLang
CertifierIDFile property string$ = notesRegistration.CertifierIDFile
CreateMailDb property flag = notesRegistration.CreateMailDb
Expiration property date = notesRegistration.Expiration
IDType property type% = notesRegistration.IDType
IsNorthAmerican property flag = notesRegistration.IsNorthAmerican
MinPasswordLength property strength% = notesRegistration.MinPasswordLength
OrgUnit property string$ = notesRegistration.OrgUnit
RegistrationLog property string$ = notesRegistration.RegistrationLog
RegistrationServer property string$ = notesRegistration.RegistrationServer
StoreIDInAddressBook property flag = notesRegistration.StoreIDInAddressBook
UpdateAddressBook property flag = notesRegistration.UpdateAddressBook
Methods:
AddCertifierToAddressBook method Call notesRegistration.AddCertifierToAddressBook(idfile$ [, certpw$ [, location$ [, comment$]]])
AddServerToAddressBook method Call notesRegistration.AddServerToAddressBook( idfile$, server$, domain$ [, userpw$ [, network$ [, adminname$ [, title$ [,location$ [, comment$]]]]]])
AddUserProfile method Call notesRegistration.AddUserProfile( username$, profilename$)
AddUserToAddressBook method Call notesRegistration.AddUserToAddressBook( idfile$, fullname$, lastname$ [, userpw$ [, firstname$ [, middle$ [, mailserver$ [, maildbpath$ [, fwdaddress$ [,location$ [, comment$]]]]]]]] )
CrossCertify method Call notesRegistration.CrossCertify( idfile$ [,certpw$ [, comment$]])
DeleteIDOnServer method Call notesRegistration.DeleteIDOnServer(username$, isserverid )
GetIDFromServer method Call notesRegistration.GetIDFromServer( username$, filepath$, isserverid )
GetUserInfo method Call notesRegistration.GetUserInfo( username$ [, retmailServer$ [, retmailFile$ [, retmailDomain$ [, retmailSystem% [ , retprofile$ ]]]]])
Recertify method Call notesRegistration.Recertify( idfile$ [,certpw$ [, comment$]])
RegisterNewCertifier method Call notesRegistration.RegisterNewCertifier( organization$, idfile$, certpw$ [, country$ ]] )
RegisterNewServer method Call notesRegistration.RegisterNewServer( server$, idfile$, domain$ [, servpw$ [, certpw$ [, location$ [, comment$ [, network$ [, adminname$ [, title$]]]]]]] )
RegisterNewUser method Call notesRegistration.RegisterNewUser( lastname$, idfile$, regserver$ [, firstname$ [, middle$ [, certpw$ [, location$ [, comment$ [, maildbpath$ [, fwddomain$ [, userpw$ [, usertype% [, altname [, alt
SwitchToID method Call notesRegistration.SwitchToID( idfile$ [ , userpw$ ])
NotesReplicationEntry Class
Properties:
Destination property server$ = notesReplicationEntry.Destination
Formula property formula$ = notesReplicationEntry.Formula
IsIncludeACL property flag = notesReplicationEntry.IsIncludeACL
IsIncludeAgents property flag = notesReplicationEntry.IsIncludeAgents
IsIncludeDocuments property flag = notesReplicationEntry.IsIncludeDocuments
IsIncludeForms property flag = notesReplicationEntry.IsIncludeForms
IsIncludeFormulas property flag = notesReplicationEntry.IsIncludeFormulas
Source property server$ = notesReplicationEntry.Source
Views property views$ = notesReplicationEntry.Views
Methods:
Remove method Call notesReplicationEntry.Remove()
Save method Call notesReplicationEntry.Save()
NotesRichTextDocLink Class
Properties:
DbReplicaID property replicaid$ = notesRichTextDocLink.DbReplicaID
DisplayComment property comment$ = notesRichTextDocLink.DisplayComment To set: notesRichTextDocLink.DisplayComment = comment$ Example See Also Working with doclinks in LotusScript classes
DocUNID property unid$ = notesRichTextDocLink.DocUNID
HotSpotText property text$ = notesRichTextDocLink.HotSpotText
HotSpotTextStyle property Set notesRichTextStyle = notesRichTextDocLink.HotSpotTextStyle
ServerHint property server$ = notesRichTextDocLink.ServerHint
ViewUNID property unid$ = notesRichTextDocLink.ViewUNID
Methods:
Remove method Call notesRichTextDocLink.Remove Example See Also Working with doclinks in LotusScript classes
SetHotSpotTextStyle method Call notesRichTextDocLink.SetHotSpotTextStyle( notesRichTextStyle )
NotesRichTextItem Class
Properties:
EmbeddedObjects property notesEmbeddedObjectArray = notesRichTextItem.EmbeddedObjects
Methods:
AddNewLine method Call notesRichTextItem.AddNewLine( n% [, forceParagraph ] )
AddPageBreak method Call notesRichTextItem.AddPageBreak( [RTPStyleNotesRichTextParagraphStyle] )
AddTab method Call notesRichTextItem.AddTab( n% )
AppendDocLink method Call notesRichTextItem.AppendDocLink( linkTo, comment$ [, HotSpotText$ ] )
AppendParagraphStyle method Call notesRichTextItem.AppendParagraphStyle( RTPStyleNotesRichTextParagraphStyle )
AppendRTItem method Call notesRichTextItem.AppendRTItem( notesRichTextItem2 )
AppendStyle method Call notesRichTextItem.AppendStyle( notesRichTextStyle )
AppendTable method Call notesRichTextItem.AppendTable( rows%, columns% [, labels] [, leftMargin&] [, rtpsStyleArray] )
AppendText method Call notesRichTextItem.AppendText( text$ )
BeginInsert method Call notesRichTextItem.BeginInsert( element, [ after ] )
BeginSection method Call notesRichTextItem.BeginSection( title, [ titleStyle ], [ barColor ], [ expand ] )
Compact method Call notesRichTextItem.Compact
CreateNavigator method Set notesRichTextNavigator = notesRichTextItem.CreateNavigator
CreateRange method Set notesRichTextRange = notesRichTextItem.CreateRange
EmbedObject method Set notesEmbeddedObject = notesRichTextItem.EmbedObject( type%, class$, source$, [ name$ ] )
EndInsert method Call notesRichTextItem.EndInsert Example See Also Writing in rich text items in LotusScript classes
EndSection method Call notesRichTextItem.EndInsert Example See Also Working with sections in LotusScript classes
GetEmbeddedObject method Set notesEmbeddedObject = notesRichTextItem.GetEmbeddedObject( name$ )
GetFormattedText method plainText$ = notesRichTextItem.GetFormattedText( tabstrip, lineLength% )
GetNotesFont method notesFont% = notesRichTextItem.GetFormattedText( faceName$, addOnFail )
GetUnformattedText method plainText$ = notesRichTextItem.GetUnformattedText( )
Update method Call notesRichTextItem.Update
NotesRichTextnavigator Class
Methods:
Clone method Set notesRichTextNavigator = notesRichTextNavigator.Clone
FindFirstElement method flag = notesRichTextNavigator.FindFirstElement( type% )
FindFirstString method flag = notesRichTextNavigator.FindFirstString( target$ [ , options& ] )
FindLastElement method flag = notesRichTextNavigator.FindLastElement( type% )
FindNextElement method flag = notesRichTextNavigator.FindNextElement( [ type% ] [, occurrence& ] )
FindNextString method flag = notesRichTextNavigator.FindNextString( target$ [ , options& ] )
FindNthElement method flag = notesRichTextNavigator.FindNthElement( type% [, occurrence& ] )
GetElement method element = notesRichTextNavigator.GetElement
GetFirstElement method element = notesRichTextNavigator.GetFirstElement( type% )
GetLastElement method element = notesRichTextNavigator.GetLastElement( type% )
GetNextElement method element = notesRichTextNavigator.GetNextElement( [ type% ] [, occurrence& ] )
GetNthElement method element = notesRichTextNavigator.GetNthElement( type% [, occurrence&] )
SetCharOffset method Call notesRichTextNavigator.SetCharOffset( offset% )
SetPosition method Call notesRichTextNavigator.SetPosition( element )
SetPositionAtEnd method Call notesRichTextNavigator.SetPositionAtEnd( element )
NotesrRichTextrange Class
Properties:
Navigator property Set notesRichTextNavigator = notesRichTextRange.Navigator
Style property Set notesRichTextStyle = notesRichTextRange.Style Example
TextParagraph property text$ = notesRichTextRange.TextParagraph
TextRun property text$ = notesRichTextRange.TextRun
Type property type& = notesRichTextRange.Type
Methods:
Clone method Set notesRichTextRange = notesRichTextRange.Clone
FindAndReplace method flag = notesRichTextRange.FindAndReplace( target$ , replacement$ , [ options& ] )
Remove method Call notesRichTextRange.Remove
Reset method Call notesRichTextRange.Reset( [ begin ] [, end ] )
SetBegin method Call notesRichTextRange.SetBegin( element )
SetEnd method Call notesRichTextRange.SetEnd( element )
SetStyle method Call notesRichTextRange.SetStyle( style )
NotesRichTextsection Class
Properties:
BarColor property Set notesColorObject = notesRichTextSection.BarColor
IsExpanded property flag = notesRichTextSection.IsExpanded
Title property title = notesRichTextSection.Title To set: notesRichTextSection.Title = title Example See Also Working with sections in LotusScript classes
TitleStyle property Set notesRichTextStyle = notesRichTextSection.TitleStyle
Methods:
Remove method Call notesRichTextSection.Remove Example See Also Working with sections in LotusScript classes
SetBarColor method Call notesRichTextSection.SetBarColor( notesColorObject )
SetTitleStyle method Call notesRichTextSection.SetTitleStyle( notesRichTextStyle )
NotesRichTextstyle Class
Properties:
Bold property flag = notesRichTextStyle.Bold
Effects property effects = notesRichTextStyle.Effects
FontSize property fontSize% = notesRichTextStyle.FontSize
IsDefault property flag = notesRichTextStyle.IsDefault
Italic property flag = notesRichTextStyle.Italic
NotesColor property notesColor = notesRichTextStyle.NotesColor
NotesFont property notesFont = notesRichTextStyle.NotesFont
Parent property Set notesSession = notesRichTextStyle.Parent
PassThruHTML property flagIntegerConstant = notesRichTextStyle.PassThruHTML
StrikeThrough property flag = notesRichTextStyle.StrikeThrough
Underline property flag = notesRichTextStyle.Underline
NotesRichTexttable Class
Properties:
AlternateColor property Set notesColorObject = notesRichTextTable.AlternateColor
Color property Set notesColorObject = notesRichTextTable.Color
ColumnCount property columns% = notesRichTextTable.ColumnCount Example See Also Working with tables in LotusScript classes
RightToLeft property flag = notesRichTextTable.RighToLeft
RowCount property rows% = notesRichTextTable.RowCount Example See Also Working with tables in LotusScript classes
RowLabels property labels = notesRichTextTable.RowLabels
Style property tableStyle% = notesRichTextTable.Style
Methods:
AddRow method Call notesRichTextTable.AddRow( [count%] [, targetrow%] )
Remove method Call notesRichTextTable.Remove Example See Also Working with tables in LotusScript classes
RemoveRow method Call notesRichTextTable.RemoveRow( [count%] [, targetrow%] )
SetAlternateColor method Call notesRichTextTable.SetAlternateColor( color )
SetColor method Call notesRichTextTable.SetColor( color )
NotesSAXAttributelist Class
Properties:
Length property long = notesSAXAttributeList.Length
Methods:
GetName method name$ = GetName( index )
GetType method type$ = GetType( NameOrIndex )
GetValue method value$ = GetValue( NameOrIndex )
NotesSAXException Class
Properties:
Column property long = notesSAXException.Column
Message property message$ = notesSAXException.Message
PublicID property To get:PublicID$ = notesSAXException.PublicID
Row property long = notesSAXException.Row
SystemID property SystemID$ = notesSAXException.SystemID
NotesSAXParser Class
Properties:
InputValidationOption property option% = notesSAXParser.InputValidationOption
Methods:
Output method Call notesSAXParser.Output( outputText )
Events:
SAX_Characters event SAX_Characters( Source as NotesSAXParser, byval Characters as String, byval Length as Long )
SAX_EndDocument event SAX_EndDocument( Source as NotesSAXParser )
SAX_EndElement event SAX_EndElement( Source as NotesSAXParser, byval ElementName as String )
SAX_Error event SAX_Error( Source as NotesSAXParser, Exception as NotesSAXException )
SAX_FatalError event SAX_FatalError( Source as NotesSAXParser, Exception as NotesSAXException )
SAX_IgnorableWhiteSpace event SAX_IgnorableWhiteSpace( Source as NotesSAXParser, byval Characters as String, byval Length as Long )
SAX_NotationDecl event SAX_NotationDecl( Source as NotesSAXParser, byval NotationName as String, byval PublicID as String, byval SystemID as String )
SAX_ProcessingInstruction event SAX_ProcessingInstruction( Source as NotesSAXParser, byval Target as String, byval PIData as String )
SAX_ResolveEntity event SAX_ResolveEntity( Source as NotesSAXParser, byval PublicId as String, byval SystemId as String)
SAX_StartDocument event SAX_StartDocument( Source as NotesSAXParser )
SAX_StartElement event SAX_StartElement( Source as NotesSAXParser, byval ElementName as String, Attributes as NotesSAXAttributeList )
SAX_UnparsedEntityDecl event SAX_UnparsedEntityDecl( Source as NotesSAXParser, byval EntityName as String, byval PublicID as String, byval SystemID as String, byval NotationName as String )
SAX_Warning event SAX_Warning( Source as NotesSAXParser, Exception as NotesSAXException )
NotesSession Class
Properties:
AddressBooks property notesDatabaseArray = notesSession.AddressBooks
CommonUserName property commonName$ = notesSession.CommonUserName
ConvertMIME property flag = notesSession.ConvertMIME
CurrentAgent property Set notesAgent = notesSession.CurrentAgent
CurrentDatabase property Set notesDatabase = notesSession.CurrentDatabase
DocumentContext property Set notesDocument = notesSession.DocumentContext
EffectiveUserName property name$ = notesSession.EffectiveUserName
HttpURL property url$ = notesSession.HttpURL
International property Set:notesInternational = notesSession.International
IsOnServer property flag = notesSession.IsOnServer
LastExitStatus property code% = notesSession.LastExitStatus
LastRun property dateV = notesSession.LastRun
NotesBuildVersion property long = notesSession.NotesBuildVersion
NotesURL property url$ = notesSession.NotesURL
NotesVersion property version$ = notesSession.NotesVersion
OrgDirectoryPath property orgDirectoryPath$ = notesSession.OrgDirectoryPath
Platform property platform$ = notesSession.Platform
SavedData property To get:Set notesDocument = notesSession.SavedData
ServerName property name$ = notesSession.ServerName
URLDatabase property Set notesDatabase = notesSession.URLDatabase Example
UserGroupNameList property notesNameArray = notesSession.UserGroupNameList
UserName property name$ = notesSession.UserName
UserNameList property notesNameArray = notesSession.UserNameList
UserNameObject property Set notesName = notesSession.UserNameObject
Methods:
CreateAdministrationProcess method Set notesAdministrationProcess = notesSession.CreateAdministrationProcess( server$ )
CreateColorObject method Set notesColorObject = notesSession.CreateColorObject( )
CreateDateRange method Set notesDateRange = notesSession.CreateDateRange( )
CreateDateTime method Set notesDateTime = notesSession.CreateDateTime( dateTime$ )
CreateDOMParser method Set notesDOMParser = notesSession.CreateDOMParser( [ input [, output ] ] )
CreateDXLExporter method Set notesDXLExporter = notesSession.CreateDXLExporter( [ input [, output ] ] )
CreateDXLImporter method Set notesDXLImporter = notesSession.CreateDXLImporter( [ input [, output ] ] )
CreateLog method Set notesLog = notesSession.CreateLog( programName$ )
CreateName method Set notesName = notesSession.CreateName( name$ [, language$ ] )
CreateNewsletter method Set notesNewsletter = notesSession.CreateNewsletter( notesDocumentCollection )
CreateRegistration method Set notesRegistration = notesSession.CreateRegistration( )
CreateRichTextParagraphStyle method Set notesRichTextParagraphStyle = notesSession.CreateRichTextParagraphStyle( )
CreateRichTextStyle method Set notesRichTextStyle = notesSession.CreateRichTextStyle( )
CreateSAXParser method Set notesSAXParser = notesSession.CreateSAXParser( [ input [, output ] ])
CreateStream method Set notesStream = notesSession.CreateStream( )
CreateTimer method Set notesTimer = notesSession.CreateTimer( )
CreateXSLTransformer method Set notesXSLTransformer = notesSession.CreateXSLTransformer( [ input [, styleSheet [, output ] ] ])
Evaluate method variant = notesSession.Evaluate( formula$, doc )
FreeTimeSearch method Set notesDateRange = notesSession.FreeTimeSearch( window, duration, names [, firstfit ] )
GetDatabase method Set notesDatabase = notesSession.GetDatabase( server$, dbfile$ [, createonfail ] )
GetDbDirectory method Set notesDbDirectory = notesSession.GetDbDirectory( serverName$ )
GetEnvironmentString method value$ = notesSession.GetEnvironmentString( name$ [, system ] )
GetEnvironmentValue method valueV = notesSession.GetEnvironmentValue( name$ [, system ] )
GetUserPolicySettings method notesDocument = notesSession.GetUserPolicySettings( server$ , name$ , [type%] , [explicitPolicy$] , [reserved$] )
HashPassword method hashedPassword$ = notesSession.HashPassword( password$ )
Initialize method Call notesSession.Initialize( [ password$ ] )
InitializeUsingNotesUserName method Call notesSession.InitializeUsingNotesUserName( name$ [, password$ ] )
Resolve method unknown = notesSession.Resolve( url$ )
SendConsoleCommand method consoleReturn$ = notesSession.SendConsoleCommand( serverName$, consoleCommand$ )
SetEnvironmentVar method Call notesSession.SetEnvironmentVar( name$, valueV [, issystemvar ] )
UpdateProcessedDoc method Call notesSession.UpdateProcessedDoc( notesDocument )
VerifyPassword method flag = notesSession.VerifyPassword( password$, hashedPassword$ )
NotesStream Class
Properties:
Bytes property bytes& = notesStream.Bytes
Charset property charset$ = notesStream.Charset
IsEOS property flag = notesStream.IsEOS
IsReadOnly property flag = notesStream.IsReadOnly
Position property offset& = notesStream.Position
Methods:
Close method Call notesStream.Close
Open method flag = notesStream.Open( pathname$ [ , charset$ ] )
Read method buffer = notesStream.Read( [ length& ] )
ReadText method text$ = notesStream.ReadText( [ oneLine& ] , [ eol& ] )
Truncate method Call notesStream.Truncate
Write method bytes& = notesStream.Write( buffer )
WriteText method bytes& = notesStream.WriteText( text$ , [ eol& ] )
NotesTimer Class
Properties:
Comment property string = notesTimer.Comment
Enabled property flag = notesTimer.Enabled To get: notesTimer.Enabled = flag
Interval property interval% = notesTimer.Interval
Events:
Alarm event Alarm( Source as NotesTimer )
NotesUIDatabase Class
Properties:
Database property Set notesDatabase = notesUIDatabase.Database Example See Also Documents property
Documents property Set notesDocumentCollection = notesUIDatabase.Documents
Methods:
Close method Call notesUIDatabase.Close
OpenNavigator method Call notesUIDatabase.OpenNavigator( navigatorName$ [, fullWindow] )
OpenView method Call notesUIDatabase.OpenView( viewName$ [, key$] [, newinstance] [, replaceView] )
Events:
PostDocumentDelete event PostDocumentDelete(Source as Notesuidatabase)
PostDragDrop event PostDragDrop(Source As Notesuidatabase, EntryName, Continue As Variant)
PostDropToArchive event PostDropToArchive(Source As Notesuidatabase, EntryName, Continue As Variant)
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)
QueryDragDrop event QueryDragDrop(Source As Notesuidatabase, EntryName, Continue As Variant)
QueryDropToArchive event QueryDropToArchive(Source As Notesuidatabase, EntryName, Continue As Variant)
NotesUIDocument Class
Properties:
AutoReload property flag = notesUIDocument.AutoReload
CurrentField property fieldName$ = notesUIDocument.CurrentField
DialogBoxCanceled property flag = notesUIDocument.DialogBoxCanceled
Document property Set notesDocument = notesUIDocument.Document
EditMode property flag = notesUIDocument.EditMode
FieldHelp property flag = notesUIDocument.FieldHelp
HiddenChars property flag = notesUIDocument.HiddenChars
HorzScrollBar property flag = notesUIDocument.HorzScrollBar
InPreviewPane property flag = notesUIDocument.InPreviewPane
IsNewDoc property flag = notesUIDocument.IsNewDoc
PreviewDocLink property flag = notesUIDocument.PreviewDocLink
PreviewParentDoc property flag = notesUIDocument.PreviewParentDoc
Ruler property flag = notesUIDocument.Ruler
WindowTitle property title$ = notesUIDocument.WindowTitle Example See Also Accessing the current document
Methods:
Categorize method Call notesUIDocument.Categorize( [ categoryName$ ] )
Clear method Call notesUIDocument.Clear
Close method Call notesUIDocument.Close( [ immediate ] )
CollapseAllSections method Call notesUIDocument.CollapseAllSections
Copy method Call notesUIDocument.Copy
CreateObject method Set handleV = notesUIDocument.CreateObject( [ name$ [ , type$ _ [ , filePath$ ] ] ] )
Cut method Call notesUIDocument.Cut
DeleteDocument method Call notesUIDocument.DeleteDocument
DeselectAll method Call notesUIDocument.DeselectAll
ExpandAllSections method Call notesUIDocument.ExpandAllSections
FieldAppendText method Call notesUIDocument.FieldAppendText( fieldName$, text$ )
FieldClear method Call notesUIDocument.FieldClear( [ fieldName$ ] )
FieldContains method flag = notesUIDocument.FieldContains( fieldName$, textValue$ )
FieldGetText method textValue$ = notesUIDocument.FieldGetText( [ fieldName$ ] )
FieldSetText method Call notesUIDocument.FieldSetText( fieldName$, textValue$ )
FindFreeTimeDialog method Call notesUIDocument.FindFreeTimeDialog( reqPeopleItems$, optPeopleItems$, reqRoomsItems$, optRoomsItems$, reqResourcesItems$, optResourcesItems$, removedPeopleItems$, startDateItem$, endDateItem$ )
FindFreeTimeDialogEx method flag = notesUIDocument.FindFreeTimeDialogEx( reqPeopleItems$, optPeopleItems$, reqRoomsItems$, optRoomsItems$, reqResourcesItems$, optResourcesItems$, removedPeopleItems$, startDateItem$, endDateItem$ )
FindString method Call notesUIDocument.FindString(text$ [, wholeword ] [, backwards ] [, caseSensitive ] [, wildCards ] [, accentSensitive ] [, searchDocument ] [, findNext ] [, wrapAround ] [, ignoreDiacritics ])
Forward method Call notesUIDocument.Forward
GetObject method Set handleV = notesUIDocument.GetObject( name$ )
GetSchedulerObject method Set notesUIScheduler = notesUIDocument.GetSchedulerObject( name$ )
GetSelectedText method text$ = notesUIDocument.GetSelectedText( [ fieldName$ ] )
GotoBottom method Call notesUIDocument.GotoBottom
GotoField method Call notesUIDocument.GotoField( fieldName$ )
GotoNextField method Call notesUIDocument.GotoNextField
GotoPrevField method Call notesUIDocument.GotoPrevField
GotoTop method Call notesUIDocument.GotoTop
Import method Call notesUIDocument.Import( [ filter$ , filename$ ] )
InsertText method Call notesUIDocument.InsertText( textValue$ )
NavBarSetText method Call notesUIDocument.NavBarSetText( urltext , windowtitle )
NavBarSpinnerStart method Call notesUIDocument.NavBarSpinnerStart( )
NavBarSpinnerStop method Call notesUIDocument.NavBarSpinnerStop( )
Paste method Call notesUIDocument.Paste
Print method Call notesUIDocument.Print or Call notesUIDocument.Print( [ numCopies%, [, fromPage%, [, toPage%, [,draft ]]]] )
Refresh method Call notesUIDocument.Refresh( [ IncludeRichTextItems ] )
RefreshHideFormulas method Call notesUIDocument.RefreshHideFormulas
Reload method Call notesUIDocument.Reload( )
Save method Call notesUIDocument.Save
SaveNewVersion method Call notesUIDocument.SaveNewVersion
SelectAll method Call notesUIDocument.SelectAll
Send method Call notesUIDocument.Send
SpellCheck method Call notesUIDocument.SpellCheck()
Events:
OnHelp event OnHelp(Source as NotesUIDocument)
OnLoad event onLoad( Source as NotesUIDocument )
OnSubmit event OnSubmit( Source as NotesUIDocument , Continue as Variant )
OnUnload event OnUnload( Source as NotesUIDocument, Continue as Variant )
PostModeChange event PostModeChange( Source as NotesUIDocument )
PostOpen event PostOpen( Source as NotesUIDocument )
PostRecalc event PostRecalc( Source as NotesUIDocument )
PostSave event PostSave( Source as NotesUIDocument )
PostSend event PostSend(Source as NotesUIDocument)
QueryClose event QueryClose( Source as NotesUIDocument, Continue as Variant )
QueryModeChange event QueryModeChange( Source as NotesUIDocument , Continue as Variant )
QueryOpen event QueryOpen( Source as NotesUIDocument, Mode as Integer, IsNewDoc as Variant, Continue as Variant )
QueryRecalc event QueryRecalc( Source as NotesUIDocument , Continue as Variant )
QuerySave event QuerySave( Source as NotesUIDocument , Continue as Variant )
QuerySend event QuerySend(Source as NotesUIDocument , Continue as Variant)
NotesUIScheduler Class
Properties:
ColorLegend property flag = notesUIScheduler.ColorLegend
DisplayAlternateNames property flag = notesUIScheduler.DisplayAlternateNames
DisplayHoursPerDay property hours& = notesUIScheduler.DisplayHoursPerDay To set: notesUIScheduler.DisplayHoursPerDay = hours& Example See Also Creating an embedded editor
DisplayMeetingSuggestions property flag = notesUIScheduler.DisplayMeetingSuggestions
DisplayParticipantStatus property flag = notesUIScheduler.DisplayParticipantStatus
DisplayPeople property flag = notesUIScheduler.DisplayPeople
DisplayResources property flag = notesUIScheduler.DisplayResources
DisplayRooms property flag = notesUIScheduler.DisplayRooms
DisplayTwisties property flag = notesUIScheduler.DisplayTwisties
Interval property Set notesDateRange = notesUIScheduler.Interval To set: Set notesUIScheduler.Interval = notesDateRange Example See Also Creating an embedded editor
MeetingIndicator property flag = notesUIScheduler.MeetingIndicator
ScheduleGridStart property Set notesDateTime = notesUIScheduler.ScheduleGridStart To set: Set notesUIScheduler.ScheduleGridStart = notesDateTime Example See Also Creating an embedded editor
SchedulerName property name$ = notesUIScheduler.SchedulerName Example See Also Creating an embedded editor
TimeZone property timeZone$ = notesUIScheduler.TimeZone
Methods:
AddParticipant method Call notesUIScheduler.AddParticipant( name$, role&, status& [, type&] [, alternateName$] [, inetName$] [, storageType$] [, flags&] )
GetParticipants method participants = notesUIScheduler.GetParticipants( participantType& )
GetScheduleData method Call notesUIScheduler.GetScheduleData( [ flag ] )
RemoveParticipants method Call notesUIScheduler.RemoveParticipants( [ participants ] )
Events:
OnIntervalChange event OnIntervalChange(Source As Notesuischeduler)
NotesUIView Class
Properties:
CalendarDateTime property dateV = notesUIView.CalendarDateTime
CalendarDateTimeEnd property dateV = notesUIView.CalendarDateTimeEnd
CaretCategory property variant = notesUIView.CaretCategory
CaretNoteID property caretNoteID$ = notesUIView.CaretNoteID
Documents property Set notesDocumentCollection = notesUIView.Documents
View property Set notesView = notesUIView.View Example
ViewAlias property viewAlias$ = notesUIView.ViewAlias
ViewInheritedFrom property viewName$ = notesUIView.ViewInheritedFrom Example
ViewName property viewName$ = notesUIView.ViewName
Methods:
Close method Call notesUIView.Close
DeselectAll method Call notesUIView.DeselectAll
Print method Call notesUIView.Print Call notesUIView.Print( numCopies% [, fromPage% ] [, toPage% ] [, draft ] [, pageSeparator% ] [, formOverride$ ] [, printview ] [, dateRangeBegin ] [, dateRangeEnd ] )
SelectDocument method Call notesUIView.SelectDocument( notesdocument )
Events:
InViewEdit event InViewEdit(Source As NotesUIView, RequestType As Integer, ColProgName As Variant, ColumnValue As Variant, Continue As Variant)
PostDragDrop event PostDragDrop(Source As Notesuiview)
PostEntryResize event PostEntryResize(Source As Notesuiview)
PostOpen event PostOpen(Source As Notesuiview)
PostPaste event PostPaste(Source As Notesuiview)
QueryAddToFolder event QueryAddToFolder(Source As Notesuiview, Target As Variant, Continue As Variant)
QueryClose event QueryClose(Source As Notesuiview, Continue As Variant)
QueryDragDrop event QueryDragDrop(Source As Notesuiview, Continue As Variant)
QueryEntryResize event QueryEntryResize(Source As Notesuiview, Continue As Variant)
QueryOpen event QueryOpen(Source As Notesuiview, Continue As Variant)
QueryOpenDocument event QueryOpenDocument(Source As Notesuiview, Continue As Variant)
QueryPaste event QueryPaste(Source As Notesuiview, Continue As Variant)
QueryRecalc event QueryRecalc(Source As Notesuiview, Continue As Variant)
RegionDoubleClick event RegionDoubleClick(Source As Notesuiview)
NotesUIWorkspace Class
Properties:
CurrentCalendarDateTime property dateV = notesUIWorkspace.CurrentCalendarDateTime Example See Also CalendarDateTime property
CurrentDatabase property Set notesUIDatabase = notesUIWorkspace.CurrentDatabase
CurrentDocument property Set notesUIDocument = notesUIWorkspace.CurrentDocument
CurrentView property Set notesUIView = notesUIWorkspace.CurrentView
Methods:
AddDatabase method Call notesUIWorkspace.AddDatabase( server$ , filename$ )
CheckAlarms method Call notesUIWorkspace.CheckAlarms( )
ComposeDocument method Set notesUIDocument = notesUIWorkspace.ComposeDocument( [ server$ [, file$ [, form$ [, windowWidth# [, windowHeight# [, returnNotesUIDocument]]]]]] )
DialogBox method flag = notesUIWorkspace.DialogBox( form$ , [autoHorzFit] , [autoVertFit] , [noCancel] , [noNewFields] , [noFieldUpdate] , [readOnly] , [title$] , [notesDocument] , [sizeToTable] , [noOkCancel] , [okCanc
EditDocument method Set notesUIDocument = notesUIWorkspace.EditDocument( [editMode] , [notesDocument] , [notesDocumentReadOnly] , [documentAnchor$] , [returnNotesUIDocument] , [newInstance] )
EditProfile method Set notesUIDocument = notesUIWorkspace.EditProfile( profileName$ [, uniqueKey$] )
EnableAlarms method Call notesUIWorkspace.EnableAlarms( enable )
Folder method variant = notesUIWorkspace.Folder( [foldername$], move )
GetCurrentDatabase method Set notesUIDatabase = notesUIWorkspace.GetCurrentDatabase
GetListOfTunes method variant = notesUIWorkspace.GetListOfTunes( )
OpenDatabase method Call notesUIWorkspace.OpenDatabase( server$, file$, view$, key$, newInstance, temp )
OpenFileDialog method stringArray = notesUIWorkspace.OpenFileDialog( multipleSelection , [title$] , [filters$] , [initialDirectory$] , [initialFile$] )
OpenFrameSet method Call notesUIWorkspace.OpenFrameSet( frameset$ )
OpenPage method Call notesUIWorkspace.OpenPage( pagename$ )
PickListCollection method Set notesDocumentCollection = notesUIWorkspace.PickListCollection( type% [, multipleSelection ], server$, databaseFileName$, viewName$, title$, prompt$ [, Singlecategory$ ] )
PickListStrings method stringArray = notesUIWorkspace.PickListStrings( type% [, multipleSelection ] )
PlayTune method Call notesUIWorkspace.PlayTune( tuneName$ )
Prompt method variant = notesUIWorkspace.Prompt( type%, title$, prompt$ [, default ] [, values ] )
RefreshParentNote method Call notesUIWorkspace.RefreshParentNote( )
ReloadWindow method Call notesUIWorkspace.ReloadWindow( )
SaveFileDialog method stringArray = notesUIWorkspace.SaveFileDialog( directoriesOnly , [title$] , [filters$] , [initialDirectory$] , [initialFile$] )
SetCurrentLocation method Call notesUIWorkspace.SetCurrentLocation( [ location$ ] )
SetTargetFrame method Call notesUIWorkspace.SetTargetFrame( frame$ )
URLOpen method Call notesUIWorkspace.URLOpen( Url$, reload%, urlList%, charset$, webusername$, webpassword$, proxywebusername$, proxywebpassword$, notesRetriever )
UseLSX method Call notesUIWorkspace.UseLSX( lsxLibraryName$ )
ViewRebuild method Call notesUIWorkspace.ViewRebuild
ViewRefresh method Call notesUIWorkspace.ViewRefresh
NotesView Class
Properties:
Aliases property aliases = notesView.Aliases
AllEntries property Set notesViewEntryCollection = notesView.AllEntries
AutoUpdate property flag = notesView.AutoUpdate
BackgroundColor property color% = notesView.BackgroundColor
ColumnCount property count% = notesView.ColumnCount
ColumnNames property variant = notesView.ColumnNames
Columns property notesViewColumnArray = notesView.Columns
Created property dateV = notesView.Created
EntryCount property count% = notesView.EntryCount Example
HeaderLines property lines% = notesView.HeaderLines
HttpURL property url$ = notesView.HttpURL
IsCalendar property flag = notesView.IsCalendar
IsCategorized property flag = notesView.IsCategorized
IsConflict property flag = notesView.IsConflict
IsDefaultView property flag = notesView.IsDefaultView To get: notesView.IsDefaultView = flag
IsFolder property flag = notesView.IsFolder
IsHierarchical property flag = notesView.IsHierarchical
IsModified property flag = notesView.IsModified
IsPrivate property flag = notesView.IsPrivate
IsProhibitDesignRefresh property flag = notesView.IsProhibitDesignRefresh
LastModified property dateV = notesView.LastModified
LockHolders property lockHolders = notesView.LockHolders
Name property name$ = notesView.Name
NotesURL property url$ = notesView.NotesURL
Parent property Set notesDatabase = notesView.Parent
ProtectReaders property flag = notesView.ProtectReaders
Readers property stringArray = notesView.Readers
RowLines property lines% = notesView.RowLines
SelectionFormula property formula$ = notesView.SelectionFormula
Spacing property spacing% = notesView.Spacing
TopLevelEntryCount property count% = notesView.TopLevelEntryCount
UniversalID property unid$ = notesView.UniversalID
ViewInheritedName property viewName$ = notesView.ViewInheritedName
Methods:
Clear method Call notesView.Clear
CopyColumn method Set notesViewColumn = notesView.CopyColumn( sourceColumn [ , destinationIndex& ] )
CreateColumn method Set notesViewColumn = notesView.CreateColumn( [ position& ] [ , columnName$ ] [ , formula$ ] )
CreateViewNav method Set notesViewNavigator = notesView.CreateViewNav( cacheSize& )
CreateViewNavFrom method Set notesViewNavigator = notesView.CreateViewNavFrom( navigatorObject [, cacheSize& ] )
CreateViewNavFromCategory method Set notesViewNavigator = notesView.CreateViewNavFromCategory( category$ [ , cacheSize& ] )
CreateViewNavFromChildren method Set notesViewNavigator = notesView.CreateViewNavFromChildren( navigatorObject [ , cacheSize& ] )
CreateViewNavFromDescendants method Set notesViewNavigator = notesView.CreateViewNavFromDescendants( navigatorObject [ , cacheSize& ] )
CreateViewNavMaxLevel method Set notesViewNavigator = notesView.CreateViewNavMaxLevel( level& [, cacheSize& ] )
FTSearch method numDocs& = notesView.FTSearch( query$, maxDocs% )
GetAllDocumentsByKey method Set notesDocumentCollection = notesView.GetAllDocumentsByKey( keyArray [, exactMatch% ] )
GetAllEntriesByKey method Set notesViewEntryCollection = notesView.GetAllEntriesByKey( keyArray [, exactMatch% ] )
GetChild method Set notesDocument = notesView.GetChild( document )
GetColumn method Set notesViewColumn = notesView.Column( columnNumber& )
GetDocumentByKey method Set notesDocument = notesView.GetDocumentByKey( keyArray [, exactMatch% ] )
GetEntryByKey method Set notesViewEntry = notesView.GetEntryByKey( keyArray [, exactMatch% ] )
GetFirstDocument method Set notesDocument = notesView.GetFirstDocument
GetLastDocument method Set notesDocument = notesView.GetLastDocument
GetNextDocument method Set notesDocument = notesView.GetNextDocument( document )
GetNextSibling method Set notesDocument = notesView.GetNextSibling( document )
GetNthDocument method Set notesDocument = notesView.GetNthDocument( index& )
GetParentDocument method Set notesDocument = notesView.GetParentDocument( document )
GetPrevDocument method Set notesDocument = notesView.GetPrevDocument( document )
GetPrevSibling method Set notesDocument = notesView.GetPrevSibling( document )
Lock method flag = notesView.Lock( [ name ] [ , provisionalOK ] )
LockProvisional method flag = notesView.LockProvisional( [ name ] )
Refresh method Call notesView.Refresh
Remove method Call notesView.Remove
RemoveColumn method Call notesView.RemoveColumn( [ columnNameOrIndex ] )
SetAliases method return& = notesView.SetAliases( alias )
Unlock method Call notesView.Unlock( )
NotesViewColumn Class
Properties:
Alignment property alignment% = notesViewColumn.Alignment
DateFmt property fmt% = notesViewColumn.DateFmt
FontColor property To get:color% = notesViewColumn.FontColor
FontFace property To get:face$ = notesViewColumn.FontFace
FontPointSize property size% = notesViewColumn.FontPointSize
FontStyle property To get:style% = notesViewColumn.FontStyle
Formula property formula$ = notesViewColumn.Formula
HeaderAlignment property alignment% = notesViewColumn.HeaderAlignment
HeaderFontColor property color% = notesViewColumn.HeaderFontColor
HeaderFontFace property face$ = notesViewColumn.HeaderFontFace
HeaderFontPointSize property size% = notesViewColumn.HeaderFontPointSize To set: notesViewColumn. HeaderFontPointSize = size% Example
HeaderFontStyle property style% = notesViewColumn.HeaderFontStyle
IsAccentSensitiveSort property flag = notesViewColumn.IsAccentSensitiveSort
IsCaseSensitiveSort property flag = notesViewColumn.IsCaseSensitiveSort
IsCategory property flag = notesViewColumn.IsCategory
IsField property flag = notesViewColumn.IsField
IsFontBold property flag = notesViewColumn.IsFontBold
IsFontItalic property flag = notesViewColumn.IsFontItalic
IsFontStrikethrough property flag = notesViewColumn.IsFontStrikethrough
IsFontUnderline property flag = notesViewColumn.IsFontUnderline
IsFormula property flag = notesViewColumn.IsFormula
IsHeaderFontBold property flag = notesViewColumn.IsHeaderFontBold
IsHeaderFontItalic property flag = notesViewColumn.IsHeaderFontItalic
IsHeaderFontStrikethrough property flag = notesViewColumn.IsHeaderFontStrikethrough
IsHeaderFontUnderline property flag = notesViewColumn.IsHeaderFontUnderline
IsHidden property flag = notesViewColumn.IsHidden
IsHideDetail property flag = notesViewColumn.IsHideDetail
IsIcon property flag = notesViewColumn.IsIcon
IsNumberAttribParens property flag = notesViewColumn.IsNumberAttribParens
IsNumberAttribPercent property flag = notesViewColumn.IsNumberAttribPercent
IsNumberAttribPunctuated property flag = notesViewColumn.IsNumberAttribPunctuated
IsResize property flag = notesViewColumn.IsResize
IsResortAscending property flag = notesViewColumn.IsResortAscending
IsResortDescending property flag = notesViewColumn.IsResortDescending
IsResortToView property flag = notesViewColumn.IsResortToView
IsResponse property flag = notesViewColumn.IsResponse
IsSecondaryResort property flag = notesViewColumn.IsSecondaryResort
IsSecondaryResortDescending property flag = notesViewColumn.IsSecondaryResortDescending
IsShowTwistie property flag = notesViewColumn.IsShowTwistie
IsSortDescending property flag = notesViewColumn.IsSortDescending
IsSorted property flag = notesViewColumn.IsSorted
ItemName property name$ = notesViewColumn.ItemName
ListSep property sep% = notesViewColumn.ListSep
NumberAttrib property attrib% = notesViewColumn.NumberAttrib
NumberDigits property digits% = notesViewColumn.NumberDigits
NumberFormat property format% = notesViewColumn.NumberFormat
Parent property Set notesView = notesViewColumn.Parent
Position property pos% = notesViewColumn.Position
ResortToViewName property viewName = notesViewColumn.ResortToViewName
SecondaryResortColumnIndex property columnIndex = notesViewColumn.SecondaryResortColumnIndex
TimeDateFmt property fmt% = notesViewColumn.TimeDateFmt
TimeFmt property fmt% = notesViewColumn.TimeFmt
TimeZoneFmt property fmt% = notesViewColumn.TimeZoneFmt
Title property title$ = notesViewColumn.Title
Width property width% = notesViewColumn.Width
NotesViewNavigator Class
Properties:
CacheSize property size& = notesViewNavigator.CacheSize
Count property count& = notesViewNavigator.Count
MaxLevel property maxlevel& = notesViewNavigator.MaxLevel
ParentView property Set notesView = notesViewNavigator.ParentView
Methods:
GetChild method Set notesViewEntry = notesViewNavigator.GetChild( entry )
GetCurrent method Set notesViewEntry = notesViewNavigator.GetCurrent( )
GetEntry method Set notesViewEntry = notesViewNavigator.GetEntry( entry )
GetFirst method Set notesViewEntry = notesViewNavigator.GetFirst
GetFirstDocument method Set notesViewEntry = notesViewNavigator.GetFirstDocument
GetLast method Set notesViewEntry = notesViewNavigator.GetLast
GetLastDocument method Set notesViewEntry = notesViewNavigator.GetLastDocument
GetNext method Set notesViewEntry = notesViewNavigator.GetNext( entry )
GetNextCategory method Set notesViewEntry = notesViewNavigator.GetNextCategory( entry )
GetNextDocument method Set notesViewEntry = notesViewNavigator.GetNextDocument( entry )
GetNextSibling method Set notesViewEntry = notesViewNavigator.GetNextSibling( entry )
GetNth method Set notesViewEntry = notesViewNavigator.GetNth( index& )
GetParent method Set notesViewEntry = notesViewNavigator.GetParent( entry )
GetPos method Set notesViewEntry = notesViewNavigator.GetPos( position$, separator$ )
GetPrev method Set notesViewEntry = notesViewNavigator.GetPrev( entry )
GetPrevCategory method Set notesViewEntry = notesViewNavigator.GetPrevCategory( entry )
GetPrevDocument method Set notesViewEntry = notesViewNavigator.GetPrevDocument( entry )
GetPrevSibling method Set notesViewEntry = notesViewNavigator.GetPrevSibling( entry )
GotoChild method Call notesViewNavigator.GotoChild( entry )
GotoEntry method Call notesViewNavigator.GotoEntry( objUnknown )
GotoFirst method Call notesViewNavigator.GotoFirst( )
GotoFirstDocument method Call notesViewNavigator.GotoFirstDocument( )
GotoLast method Call notesViewNavigator.GotoLast( )
GotoLastDocument method Call notesViewNavigator.GotoLastDocument( )
GotoNext method Call notesViewNavigator.GotoNext( entry )
GotoNextCategory method Call notesViewNavigator.GotoNextCategory( entry )
GotoNextDocument method Call notesViewNavigator.GotoNextDocument( entry )
GotoNextSibling method Call notesViewNavigator.GotoNextSibling( entry )
GotoParent method Call notesViewNavigator.GotoParent( entry )
GotoPos method Call notesViewNavigator.GotoPos( pos$, separator$ )
GotoPrev method Call notesViewNav