Transcript
Page 1: Domino Objects for LotusScript/COM/OLE, Part 1rockingchairsoftware.com/rcsweb.nsf/ab695cabc0856bef852571e8004feaf0...Domino Objects for LotusScript/COM/OLE, Part 1 Supports Visual

®

Domino Objects for LotusScript/COM/OLE, Part 1Supports Visual Basic, VBA, VBS, Delphi, and other COM- and OLE-compliant languagesIBM Lotus Notes® and DominoTM 6

All trademarks are the property of their respective owners G210-1442-00

www.lotus.com/ldd/doc

Front-End Classes

Code SampleDim ws As New NotesUIWorkspaceDim uidoc As NotesUIDocumentDim lastname As StringCall ws.OpenDatabase(“snapper”, “names”, _

“People”, “A”)Set uidoc = ws.EditDocument(False)lastname = uidoc.FieldGetText(“LastName”)

Field

EventsEntering(source)Exiting(source)OnBlur(source)OnChange(source)OnFocus(source)

Button

EventsClick(source)ObjectExecute(source, data)

Not supported by COM

COM only

Navigator

EventsClick(source)

Back-End Classes

NotesUIWorkspaceNot supported by COM

Propertiesdatevariable = CurrentCalendarDateTimenotesuidatabase = CurrentDatabasenotesuidocument = CurrentDocumentnotesuiview = CurrentViewMethodsnotesuiworkspace = New NotesUIWorkspaceAddDatabase(server, fi lename)CheckAlarmsnotesuidocument = ComposeDocument([server],

[fi le], [form], [windowwidth], [windowheight], [returnnotesuidocument])

fl ag = DialogBox(form, [autohorzfi t], [autovertfi t], [nocancel], [nonewfi elds], [nofi eldupdate], [readonly], [title], [notesdocument], [sizetotable], [nookcancel], [okcancelatbottom])

notesuidocument = EditDocument([editmode], [notesdocument], [notesdocumentreadonly], [documentanchor], [returnnotesuidocument], [newinstance])

notesuidocument = EditProfi le(profi lename, [uniqueKey])

EnableAlarms(enable)variant = Folder([foldername], move)notesuidatabase = GetCurrentDatabasevariant = GetListOfTunesOpenDatabase(server, fi le, view, key, newinstance,

temp)stringarray = OpenFileDialog(multipleselection,

[title], [fi lters], [initialdirectory], [initialfi le])OpenFrameSet(frameset)OpenPage(pagename)notesdocumentcollection = PickListCollection(type,

[multipleselection], server, databasefi lename, viewname, title, prompt, [singlecategory])

stringarray = PickListStrings(type, [multipleselection])

stringarray = PickListStrings(type, [multipleselection], server, databasefi lename, viewname, title, prompt, column, [categoryname])

PlayTune(tunename)variant = Prompt(type, title, prompt, [default],

[values])RefreshParentNoteReloadWindowstringarray = SaveFileDialog(directoriesonly, [title],

[fi lters], [initialdirectory], [initialfi le])SetCurrentLocation([location])SetTargetFrame(frame)URLOpen(url, reload, urllist, charset,

webusername, webpassword, proxywebusername, proxywebpassword, notesretriever)

UseLSX(lsxlibraryname)ViewRebuild([viewrebuild], [loadpreferences])ViewRefresh

NotesUIDocument

Propertiesbool = AutoReloadAutoReload = boolstring = CurrentFieldbool = DialogBoxCancelednotesdocument = Documentbool = EditModeEditMode = boolbool = FieldHelpFieldHelp = boolbool = HiddenCharsHiddenChars = boolbool = HorzScrollBarHorzScrollBar = boolbool = InPreviewPanebool = IsNewDocbool = PreviewDocLinkPreviewDocLink = boolbool = PreviewParentDocPreviewParentDoc = boolbool = RulerRuler = boolstring = WindowTitleMethodsCategorize([categoryname])ClearClose([immediate]) CollapseAllSectionsCopyhandlev = CreateObject([name], [type], [fi lepath])CutDeleteDocumentDeselectAllExpandAllSectionsFieldAppendText(fi eldname, text)FieldClear([fi eldname])bool = FieldContains(fi eldname, textvalue)textvalue = FieldGetText([fi eldname])FieldSetText(fi eldname, textvalue)FindFreeTimeDialog(reqpeopleitems,

optpeopleitems, reqroomsitems, optroomsitems, reqresourcesitems, optresourcesitems, removedpeopleitems, startdateitem, enddateitem)

bool = FindFreeTimeDialogEx(reqpeopleitems, optpeopleitems, reqroomsitems, optroomsitems, reqresourcesitems, optresourcesitems, removedpeopleitems, startdateitem, enddateitem)

FindString(text, [wholeword], [backwards], [casesensitive], [wildcards], [accentsensitive], [searchdocument], [fi ndnext], [wraparound], [ignorediacritics])

Forwardhandlev = GetObject(name)notesuischeduler = GetSchedulerObject(name)text = GetSelectedText([fi eldname])GotoBottomGotoField(fi eldname)GotoNextFieldGotoPrevFieldGotoTopImport([fi lter, fi lename])InsertText(textvalue)NavBarSetText(urltext, [windowtitle])NavBarSpinnerStartNavBarSpinnerStopPastePrintPrint([numcopies], [frompage], [topage], [draft])Refresh([includerichtextitems])RefreshHideFormulasReloadSaveSaveNewVersionSelectAllSendSpellCheckEventsOnHelp(source)OnLoad(source)OnSubmit(source, continue)OnUnload(source, continue)PostModeChange(source)PostOpen(source)PostRecalc(source)PostSave(source)PostSend(source)QueryClose(source, continue)QueryModeChange(source, continue)QueryOpen(source, mode, isnewdoc, continue)QueryRecalc(source, continue)QuerySave(source, continue)QuerySend(source, continue)

NotesDatabase

Propertiesstringarray = ACLActivityLognotesdocumentcollection = AllDocumentsstring = CategoriesCategories = stringdatevariant = Createdinteger = CurrentAccessLevelbool = DelayUpdatesDelayUpdates = boolstring = DesignTemplateNameinteger = FileFormatstring = FileNamestring = FilePathbool = FolderReferencesEnabledFolderReferencesEnabled = boolnotesformarray = Formsinteger = FTIndexFrequencyFTIndexFrequency = integerstring = HttpURLbool = IsClusterReplicationIsClusterReplication = boolbool = IsConfi gurationDirectorybool = IsCurrentAccessPublicReaderbool = IsCurrentAccessPublicWriterbool = IsDesignLockingEnabledIsDesignLockingEnabled = boolbool = IsDirectoryCatalogbool = IsDocumentLockingEnabledIsDocumentLockingEnabled = boolbool = IsFTindexedbool = IsInMultiDbIndexingIsInMultiDbIndexing = boolbool = IsInServiceIsInService = boolbool = IsLinkbool = IsMultiDbSearchbool = IsOpenbool = IsPendingDeletebool = IsPrivateAddressBookbool = IsPublicAddressBookdatevariant = LastFixupdatevariant = LastFTIndexeddatevariant = LastModifi eddouble = LimitRevisionsLimitRevisions = doubledouble = LimitUpdatedByLimitUpdatedBy = doublebool = ListInDbCatalogListInDbCatalog = boolstringarray = Managersdouble = MaxSizestring = NotesURLnotessession = Parentdouble = PercentUsedstring = ReplicaIDstring = Serverdouble = Sizelong = SizeQuotaSizeQuota = longinteger = SizeWarningSizeWarning = integerstring = TemplateNamestring = TitleTitle = stringinteger = Typeinteger = UndeleteExpireTimeUndeleteExpireTime = integernotesdocumentcollection = UnprocessedDocumentsnotesviewarray = ViewsMethodsnotesdatabase = New(server, dbfi le) sizedelta = Compactsizedelta = CompactWithOptions(options)sizedelta = CompactWithOptions(options,

[spacethreshold])Create(server, dbfi le, openfl ag, [maxsize])notesdatabasenew = CreateCopy(newserver,

newdbfi le, [maxsize])notesdocument = CreateDocumentnotesdatabasenew = CreateFromTemplate

(newserver, newdbfi le, inheritfl ag, [maxsize])CreateFTIndex(options, recreate)notesdatabasereplica = CreateReplica(newserver,

newdbfi le)notesview = CreateView([viewname],

[viewselectionformula], [templateview], [prohibitdsignrefreshmodifi cations])

EnableFolder(foldername)Fixup([options])notesdocument = FTDomainSearch(query,

maxdocs, [sortoptions], [otheroptions], [start], [count], [entryform])

notesdocumentcollection = FTSearch(query, maxdocs, [sortoptions], [otheroptions])

notesdocumentcollection = FTSearchRange(query,maxdocs, [sortoptions], [otheroptions], [start])

notesdocument = GetDocumentByID(noteid)notesdocument = GetDocumentByUNID(unid)notesdocument = GetDocumentByURL(url, [reload],

[urllist], [charset], [webusername], [webpassword], [proxywebusername], [proxywebpassword], [returnimmediately])

notesform = GetForm(name)fl ag = GetOption(optionname)notesdocumentcollection = GetProfi leDocCollection

(profi lename)notesdocument = GetProfi leDocument(profi lename,

[uniquekey])notesview = GetView(viewname)GrantAccess(name, level)MarkForDeleteOpen fl ag = Open(server, dbfi le) fl ag = OpenByReplicaID(server, replicaid) fl ag = OpenIfModifi ed(server, dbfi le, notesdatetime)OpenMail fl ag = OpenURLDb fl ag = OpenWithFailover(server, dbfi le) level = QueryAccess(name)roles = QueryAccessRoles(name)RemoveRemoveFTIndexfl ag = Replicate(servername)RevokeAccess(name)notesdocumentcollection = Search(formula,

notesdatetime, maxdocs)SetOption(optionname, fl ag)Sign([documenttype], [existingsigsonly], [namestr],

[namestrisnoteid])notesdocumentcollection = UnprocessedFTSearch

(query, maxdocs, [sortoptions], [otheroptions])notesdocumentcollection = UnprocessedFTSearch

Range(query, maxdocs, [sortoptions],[otheroptions], [start])

notesdocumentcollection = UnprocessedSearch(formula, notesdatetime, maxdocs)

UpdateFTIndex(createfl ag)

NotesUIDatabase

Propertiesnotesdatabase = Databasenotesdocumentcollection = DocumentsMethodsCloseOpenNavigator(navigatorname, [fullwindow])OpenView(viewname, [key], [newinstance],

[replaceview])EventsPostDocumentDelete(source)PostDragDrop(source, entryname, continue)PostDropToArchive(source, entryname, continue)PostOpen(source)QueryClose(source, continue)QueryDocumentDelete(source, continue)QueryDocumentUndelete(source, continue)QueryDragDrop(source, entryname, continue)QueryDropToArchive(source, entryname, continue)

NotesUIScheduler

Propertiesbool = ColorLegendColorLegend = boolbool = DisplayAlternateNamesDisplayAlternateNames = boollong = DisplayHoursPerDayDisplayHoursPerDay = longbool = DisplayMeetingSuggestionsDisplayMeetingSuggestions = boolbool = DisplayParticipantStatusDisplayParticipantStatus = boolbool = DisplayPeopleDisplayPeople = boolbool = DisplayResourcesDisplayResources = boolbool = DisplayRoomsDisplayRooms = boolbool = DisplayTwistiesDisplayTwisties = boolnotesdaterange = IntervalInterval = notesdaterangebool = MeetingIndicatorMeetingIndicator = boolnotesdatetime = ScheduleGridStartScheduleGridStart = notesdatetimestring = SchedulerNamestring = TimeZoneTimeZone = stringMethodsAddParticipant(name, role, status, [type],

[alternatename], [inetName], [storagetype], [fl ags])

participants = GetParticipants(participanttype)GetScheduleData([fl ag])RemoveParticipants([participants])EventsOnIntervalChange(source)

NotesDateTime

Propertiesstring = DateOnlystring = GMTTimebool = IsDSTbool = IsValidDatestring = LocalTimeLocalTime = stringdatevariant = LSGMTTimedatevariant = LSLocalTimeLSLocalTime = datevariantnotessession = Parent string = TimeOnlyinteger = TimeZonestring = ZoneTimeMethodsnotesdatetime = New NotesDateTime(datetime) AdjustDay(n, [preservelocaltime])AdjustHour(n, [preservelocaltime])AdjustMinute(n, [preservelocaltime])AdjustMonth(n, [preservelocaltime])AdjustSecond(n, [preservelocaltime])AdjustYear(n, [preservelocaltime])ConvertToZone(newzone, dst)SetAnyDateSetAnyTimeSetNowdifference = TimeDifference(notesdatetime)difference = TimeDifferenceDouble(notesdatetime)

NotesDateRange

Propertiesnotesdatetime = EndDateTimeEndDateTime = notesdatetimenotessession = Parent notesdatetime = StartDateTimeStartDateTime = notesdatetimetext = TextText = text

NotesDbDirectory

Propertiesstring = Namenotessession = Parent Methodsnotesdbdirectory = New(servername) notesdatabase = CreateDatabase(dbfi le, [open]) notesdatabase = GetFirstDatabase(fi letype)notesdatabase = GetNextDatabasenotesdatabase = OpenDatabase(dbfi le, [failover]) notesdatabase = OpenDatabaseByReplicaID(rid) notesdatabase = OpenDatabaseIfModifi ed(dbfi le,

notesdatetime) notesdatabase = OpenMailDatabase

NotesUIView

Propertiesdatevariant = CalendarDateTimedatevariant = CalendarDateTimeEndvariant = CaretCategorystring = CaretNoteIDnotesdocumentcollection = Documentsnotesview = Viewstring = ViewAliasstring = ViewInheritedFromstring = ViewNameMethodsCloseDeselectAllPrintPrint(numcopies, [frompage], [topage], [draft],

[pageseparator], [formoverride], [printview], [daterangebegin], [daterangeend])

SelectDocument(notesdocument)EventsInViewEdit(source, requesttype, colprogname,

columnvalue, continue)PostDragDrop(source)PostEntryResize(source)PostOpen(source)PostPaste(source)QueryAddToFolder(source, target, continue)QueryClose(source, continue)QueryDragDrop(source, continue)QueryEntryResize(source, continue)QueryOpen(source, continue)QueryOpenDocument(source, continue)QueryPaste(source, continue)QueryRecalc(source, continue)RegionDoubleClick(source)

NotesDocument

Propertiesstringarray = Authorsvariantarray = ColumnValuesdatevariant = Creatednotesembeddedobjectarray = EmbeddedObjectsstringarray = EncryptionKeysEncryptionKeys = stringarrayEncryptionKeys = stringbool = EncryptOnSendEncryptOnSend = boolstringarray = FolderReferencesinteger = FTSearchScorebool = HasEmbeddedstring = HttpURLbool = IsDeletedbool = IsEncryptedbool = IsNewNotebool = IsProfi lebool = IsResponsebool = IsSignedbool = IsUIDocOpenbool = IsValidnotesitemarray = Itemsstring = Keydatevariant = LastAccesseddatevariant = LastModifi edstringarray = LockHoldersstring = NameOfProfi lestring = NoteIDstring = NotesURLnotesdatabase = ParentDatabasestring = ParentDocumentUNIDnotesview = ParentViewnotesdocumentcollection = Responsesbool = SaveMessageOnSendSaveMessageOnSend = boolbool = SentByAgentstring = Signerbool = SignOnSendSignOnSend = boollong = Sizestring = UniversalIDUniversalID = stringstring = Verifi erMethodsnotesdocument = New(notesdatabase) notesitem = AppendItemValue(itemname, value)fl ag = CloseMIMEEntities([savechanges],

[entityitemname])fl ag = ComputeWithForm(dodatatypes, raiseerror)CopyAllItems(notesdocument, [replace])notesitem = CopyItem(item, newname)CopyItem(item, newname)newnotesdocument = CopyToDatabase

(notesdatabase)notesmimeentity = CreateMIMEEntity([itemname])replynotesdocument = CreateReplyMessage(all)notesrichtextitem = CreateRichTextItem(name)Encryptnotesembeddedobject = GetAttachment(fi lename)notesitem = GetFirstItem(name)valuearray = GetItemValue(itemname)notesdatetimearray = GetItemValueDateTimeArray

(itemname)notesmimeentity = GetMIMEEntity([itemname])stringarray = GetReceivedItemTextfl ag = HasItem(itemname)fl ag = Lock([name], [provisionalok])fl ag = LockProvisional([name])MakeResponse(document)PutInFolder(foldername, [createonfail])fl ag = Remove(force)RemoveFromFolder(foldername)RemoveItem(itemname)fl ag = RemovePermanently(force)fl ag = RenderToRTItem(notesrichtextitem)notesitem = ReplaceItemValue(itemname, value)fl ag = Save(force, createresponse, [markread])Send(attachForm, [recipients])SignUnlock

NotesDocumentCollection

Propertieslong = Countbool = IsSortednotesdatabase = Parentstring = QueryMethodsAddDocument(document, [checkdups])DeleteDocument(document)FTSearch(query, maxdocs)notesDocument = GetDocument(document)notesDocument = GetFirstDocumentnotesDocument = GetLastDocumentnotesDocument = GetNextDocument(document)notesDocument = GetNthDocument(n)notesDocument = GetPrevDocument(document)PutAllInFolder(foldername, [createonfail])RemoveAll(force)RemoveAllFromFolder(foldername)StampAll(itemname, value)UpdateAll

NotesSession

Propertiesnotesdatabasearray = AddressBooksstring = CommonUserNamebool = ConvertMIMEConvertMIME = boolnotesdatabase = CurrentDatabase notesdocument = DocumentContext string = EffectiveUserNamestring = HttpURLbool = IsOnServerinteger = LastExitStatusdatevariant = LastRunlong = NotesBuildVersionstring = NotesURLstring = NotesVersionstring = OrgDirectoryPathstring = Platformnotesdocument = SavedDatastring = ServerName notesdatabase = URLDatabase notesnamearray = UserGroupNameListstring = UserNamenotesnamearray = UserNameListnotesname = UserNameObject Methodsnotessession = New()notesdaterange = CreateDateRangenotesdatetime = CreateDateTime(datetime)notesnewsletter = CreateNewsletter

(notesdocumentcollection)notesrichtextparagraphstyle = CreateRich

TextParagraphStyle notesrichtextstyle = CreateRichTextStylevariant = Evaluate(formula, doc) notesdaterange = FreeTimeSearch(window,

duration, names, [fi rstfi t])notesdatabase = GetDatabase(server, dbfi le,

[createonfail])notesdbdirectory = GetDbDirectory(servername)value = GetEnvironmentString(name, [system])value = GetEnvironmentValue(name, [system])notesdocument = GetUserPolicySettings(server,

name, [type], [explicitpolicy], [reserved])hashedpassword = HashPassword(password)Initialize([password]) InitializeUsingNotesUserName(name, [password]) unknown = Resolve(url)consolereturn = SendConsoleCommand

(servername, consolecommand)SetEnvironmentVar(name, value, [issystemvar])UpdateProcessedDoc(notesdocument)fl ag = VerifyPassword(password, hashedpassword)

NotesView

Propertiesstringarray = AliasesAliases = stringarraybool = AutoUpdateAutoUpdate = bool integer = BackgroundColorBackgroundColor = integerinteger = ColumnCountvariant = ColumnNames datevariant = Createdinteger = EntryCountinteger = HeaderCountstring = HttpURLbool = IsCalendarbool = IsCategorizedbool = IsConfl ictbool = IsDefaultViewIsDefaultView = boolbool = IsFolderbool = IsHierarchicalbool = IsModifi edbool = IsPrivatebool = IsProhibitDesignRefreshIsProhibitDesignRefresh = booldatevariant = LastModifi edstringarray = LockHoldersstring = NameName = stringstring = NotesURLnotesdatabase = Parentbool = ProtectReadersProtectReaders = boolstringarray = ReadersReaders = stringarrayinteger = RowLinesstring = SelectionFormulaSelectionFormula = stringinteger = SpacingSpacing = integer integer = TopLevelEntryCountstring = UniversalIDstring = ViewInheritedNameMethodsClearnumdocs = FTSearch(query, maxdocs)notesdocumentcollection = GetAllDocumentsByKey

(keyarray, [exactmatch])notesdocument = GetChild(document)notesdocument = GetDocumentByKey(keyarray,

[exactmatch])notesdocument = GetFirstDocumentnotesdocument = GetLastDocumentnotesdocument = GetNextDocument(document)notesdocument = GetNextSibling(document)notesdocument = GetNthDocument(index)notesdocument = GetParentDocument(document)notesdocument = GetPrevDocument(document)notesdocument = GetPrevSibling(document)fl ag = Lock([name], [provisionalok])fl ag = LockProvisional([name])RefreshRemoveRemoveColumn([columnnameorindex])return = SetAliases(alias)Unlock

NotesNewsletter

Propertiesbool = DoScoreDoScore = boolbool = DoSubjectDoSubject = boolnotessession = Parentstring = SubjectItemNameSubjectItemName = stringMethodsnotesnewsletter = New(notesdocumentcollection) notesdocument = FormatDocument

(notesdatabase, n)notesdocument = FormatMsgWithDoclinks

(notesdatabase)

NotesItem

Propertiesnotesdatetime = DateTimeValueDateTimeValue = notesdatetimebool = IsAuthorsIsAuthors = boolbool = IsEncryptedIsEncrypted = boolbool = IsNamesIsNames = boolbool = IsProtectedIsProtected = boolbool = IsReadersIsReaders = boolbool = IsSignedIsSigned = boolbool = IsSummaryIsSummary = booldatevariant = LastModifi editemname = Namenotesdocument = Parentbool = SaveToDiskSaveToDisk = boolstring = Textinteger = Typeinteger = ValueLengthvaluearray = ValuesValues = valuearrayMethodsnotesitem = New(notesdocument, name, value,

[specialtype]) abbreviation = Abstract(maxabstract, dropvowels,

usedictionary)AppendToTextList(newvalue)fl ag = Contains(value)notesitem = CopyItemToDocument(document,

newname)notesmimeentity = GetMIMEEntitynotesdatetimearray = GetValueDateTimeArrayRemove

NotesForm

Propertiesstringarray = Aliasesstringarray = Fieldsstringarray = FormUsersFormUsers = stringarraystring = HttpURLbool = IsSubFormstringarray = LockHoldersstring = Namestring = NotesURLnotesdatabase = Parentbool = ProtectReadersProtectReaders = boolbool = ProtectUsersProtectUsers = boolstringarray = ReadersReaders = stringarrayMethodsinteger = GetFieldType(name)fl ag = Lock([name], [provisionalok])fl ag = LockProvisional([name])RemoveUnlock

Code SampleDim session As New NotesSessionDim db As NotesDatabaseDim dc As NotesDocumentCollectionDim doc As NotesDocumentDim lastname As StringSet db = session.GetDatabase(“snapper”,“names”)Set dc = db.AllDocumentsSet doc = dc.GetFirstDocumentlastname = doc.LastName(0)

NotesMIMEEntity

Propertiesstring = BoundaryEndstring = BoundaryStartstring = Charsetstring = ContentAsTextstring = ContentSubTypestring = ContentTypeinteger = Encodingheaderobjectarray = HeaderObjectsstring = Headersstring = PreamblePreamble = stringMethodsnotesmimeentity = CreateChildEntity([nextsibling])notesmimeheader = CreateHeader(headername)notesmimeentity = CreateParentEntityDecodeContentEncodeContent(encoding)GetContentAsBytes(stream, [decoded])GetContentAsText(stream, [decoded])GetEntityAsText(stream, [headerfi lters], [inclusive])notesmimeentity = GetFirstChildEntitynotesmimeentity = GetNextEntity([search])notesmimeentity = GetNextSiblingnotesmimeheader = GetNthHeader(headername,

[instance])notesmimeentity = GetParentEntitynotesmimeentity = GetPrevEntity([search])notesmimeentity = GetPrevSiblingheaders = GetSomeHeaders([headerfi lters],

[inclusive])RemoveSetContentFromBytes(stream, contenttype,

encoding)SetContentFromText(stream, contenttype, encoding)

NotesMIMEHeader

Propertiesstring = HeaderNameMethodsfl ag = AddValText(valuetext, [charset])headervalue = GetHeaderVal([folded], [decoded])headerandparams = GetHeaderValAndParams

([folded], [decoded])parametervalue = GetParamVal(paramname,

[folded])Removefl ag = SetHeaderVal(headervalue)fl ag = SetHeaderValAndParams(headerparamvalue)fl ag = SetParamVal(parametername,

parametervalue)

NotesRichTextItem

Propertiesnotesembeddedobjectarray = EmbeddedObjectsMethodsnotesrichtextitem = New(notesdocument, name) AddNewLine(n, [forceparagraph])AddPageBreak([rtpstyle])AddTab(n)AppendDocLink(linkto, comment, [hotspottext])AppendParagraphStyle(rtpstyle)AppendRTItem(notesrichtextitem)AppendStyle(notesrichtextstyle)AppendTable(rows, columns, [labels], [leftmargin],

[rtpstylearray])AppendText(text)BeginInsert(element, [after])BeginSection(title, [titlestyle], [barcolor], [expand])Compactnotesrichtextnavigator = CreateNavigatornotesrichtextrange = CreateRangenotesembeddedobject = EmbedObject(type, class,

source, [name])EndInsertEndSectionnotesembeddedobject =

GetEmbeddedObject(name)plaintext = GetFormattedText(tabstrip, linelength)notesfont = GetNotesFont(facename, addonfail)plaintext = GetUnformattedTextUpdate

NotesEmbeddedObject

Propertiesstring = Classlong = FileSizebool = FitBelowFieldsFitBelowFields = boolbool = FitToWindowFitToWindow = boolstring = Namevariant = Objectnotesrichtextitem = Parentbool = RunReadOnlyRunReadOnly = boolstring = Sourceinteger = Typestringarray = VerbsMethodsvariant = Activate(show)variant = DoVerb(verb)ExtractFile(path)Remove

NotesRichTextDocLink

Propertiesstring = DbReplicaIDDbReplicaID = stringstring = DisplayCommentDisplayComment = stringstring = DocUNIDDocUNID = stringstring = HotSpotTextHotSpotText = stringnotesrichtextstyle = HotSpotTextStylestring = ServerHintServerHint = stringstring = ViewUNIDViewUNID = stringMethodsRemoveSetHotSpotTextStyle(notesrichtextstyle)

NotesRichTextNavigator

Methodsnotesrichtextnavigator = Clonefl ag = FindFirstElement(type)fl ag = FindFirstString(target, [options])fl ag = FindLastElement(type)fl ag = FindNextElement([type], [occurrence])fl ag = FindNextString(target, [options])fl ag = FindNthElement(type, [occurrence])element = GetElementelement = GetFirstElement(type)element = GetLastElement(type)element = GetNextElement([type], [occurrence]) element = GetNthElement(type, [occurrence])SetCharOffset(offset)SetPosition(element)SetPositionAtEnd(element)

NotesRichTextStyle

Propertiesinteger = Bold Bold = integer long = Bold Bold = long integer = EffectsEffects = integerinteger = FontSizeFontSize = integerbool = IsDefaultinteger = Italic Italic = integer long = Italic Italic = long integer = NotesColorNotesColor = integerinteger = NotesFontNotesFont = integernotessession = Parent integer = PassThruHTML PassThruHTML = integer long = PassThruHTML PassThruHTML = long integer = StrikeThrough StrikeThrough = integer long = StrikeThrough StrikeThrough = long integer = Underline Underline = integer long = Underline Underline = long

NotesRichTextSection

Propertiesnotescolorobject = BarColorbool = IsExpandedIsExpanded = boolstring = TitleTitle = stringnotesrichtextstyle = TitleStyleMethodsRemoveSetBarColor(notescolorobject)SetTitleStyle(notesrichtextstyle)

NotesRichTextRange

Propertiesnotesrichtextnavigator = Navigatornotesrichtextstyle = Stylestring = TextParagraphstring = TextRunlong = TypeMethodsnotesrichtextrange = Clonebool = FindAndReplace(target, replacement,

[options])RemoveReset([begin], [end])SetBegin(element)SetEnd(element)SetStyle(style)

NotesRichTextTable

Propertiesnotescolorobject = AlternateColornotescolorobject = Colorinteger = ColumnCountbool = RightToLeftRightToLeft = boolinteger = RowCountstringarray = RowLabelsRowLabels = stringarrayinteger = StyleStyle = integerMethodsAddRow([count], [targetrow])RemoveRemoveRow([count], [targetrow])SetAlternateColor(color)SetColor(color)

NotesRichTextParagraphStyle

Propertiesinteger = AlignmentAlignment = integerlong = FirstLineLeftMarginFirstLineLeftMargin = longinteger = InterLineSpacingInterLineSpacing = integerlong = LeftMarginLeftMargin = longinteger = PaginationPagination = integerlong = RightMarginRightMargin = longinteger = SpacingAboveSpacingAbove = integerinteger = SpacingBelowSpacingBelow = integernotesrichtexttabarray = TabsMethodsClearAllTabsSetTab(position, type)SetTabs(number, startposition, interval, type)

NotesRichTextTab

Propertieslong = Positioninteger = TypeMethodsClear

Lotus® software

Domino, IBM, the IBM logo, Lotus, and Lotus Notes are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. Other company, product or service names may be trademarks or service marks of others.

Top Related