Accessing an outline
You can access a NotesOutline object through the CreateOutline and GetOutline methods in NotesDatabase. The CreateEntry method in NotesOutline allows you to create a new NotesOutlineEntry object and place it in the outline.
NotesOutline contains the following properties:
Property |
Data type |
Description |
---|---|---|
Alias |
String |
(Read-only) Alias name of the outline, used for programmatic access. |
Comment |
String |
(Read-only) A brief description of the outline. |
Name |
String |
(Read-only) Name of the outline, used for programmatic access. |
ParentDatabase |
NotesDatabase |
(Read-only) The parent database that contains an Outline object. For COM only. |
NotesOutline contains the following methods:
Method |
Description |
---|---|
AddEntry |
Adds a new entry to the outline. This method is obsolete as of Release 5.0.2, but is supported for backward compatibility. Use CreateEntry to add a new entry to an outline. |
CreateEntry |
Creates a new entry and adds it to an outline. |
CreateEntryForm |
Creates a copy of an existing entry. This method is new in Release 5.0.2. |
GetChild |
Gets the child of the specified entry in an outline. This method is new in Release 5.0.2. |
GetFirst |
Gets the first entry of an outline. |
GetLast |
Gets the last entry of an outline. |
GetNext |
Returns the entry immediately following the specified entry. |
GetNextSibling |
Given an entry in an outline, returns the entry immediately following it at the same level. |
GetParent |
Given a response entry in an outline, returns its parent entry. |
GetPrev |
Given an entry in an outline, returns the entry preceding it. |
GetPrevSibling |
Given an entry in an outline, returns the entry immediately preceding it at the same level. |
MoveEntry |
Moves the specified entry from one location to another in an outline. |
RemoveEntry |
Deletes the specified entry and its subentries from an outline. |
Save |
Saves any changes made to an outline. |
NotesOutlineEntry contains the following properties:
Property |
Data type |
Description |
---|---|---|
Alias |
String |
(Read-only) Alias name of the outline entry, used for programmatic access. |
Database |
NotesDatabase |
(Read-only) Database resource link for an outline entry. |
Document |
NotesDocument |
(Read-only) Document resource link for an outline entry. |
EntryClass |
Integer |
(Read-only) Class of an outline entry. |
Formula |
String |
(Read-only) Formula for an action outline. |
FrameText |
String |
(Read-only) The name of the target frame in which you want the entry to appear. |
HasChildren |
Boolean |
(Read-write) Indicates whether an entry contains child entries. |
HideFormula |
String |
(Read-write) The hide formula, if any. |
ImagesText |
String |
(Read-write) The name of the image file you would use to add an icon to your entry. |
IsHidden |
Boolean |
(Read-write) Indicates whether an entry is hidden in the current context, or sets all contexts. |
IsHiddenFromNotes |
Boolean |
(Read-write) Indicates whether an entry is hidden in the Notes® client. |
IsHiddenFromWeb |
Boolean |
(Read-write) Indicates whether an entry is hidden in a Web browser. |
IsInThisDb |
Boolean |
(Read-only) Indicates whether an entry refers to an element within the current database. |
IsPrivate |
Boolean |
(Read-only) Indicates whether an entry is specific to an individual. |
KeepSelectionFocus |
Boolean |
(Read-write) Indicates whether an entry keeps selection focus. |
Label |
String |
(Read-write) Label for an entry. |
Level |
Long |
(Read-write) Indicates the level of this entry. |
NamedElement |
String |
(Read-only) Named element referenced by an outline entry. |
Parent |
NotesOutline |
(Read-only) The outline that contains an OutlineEntry object. For COM only. |
Type |
Constant of type Long |
(Read-write) Type of outline entry. |
URL |
String |
(Read-only) The URL of an outline entry. |
UseHiddenFormula |
Boolean |
(Read-write) Indicates whether an entry uses the hide formula. |
View |
NotesView |
(Read-only) View resource link for an outline entry. |
NotesOutlineEntry contains the following methods:
Method |
Description |
---|---|
SetAction |
Specifies a formula for an action outline entry. |
SetNamedElement |
Specifies a named element for an outline entry. |
SetNoteLink |
Specifies a resource link for an outline entry. |
SetURL |
Specifies a URL as the resource link for an outline entry. |