NotesViewListColumn (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Communication

Lotus Notes functions

Notes functions

NotesViewListColumn

Presentation

Example

See also

NotesViewListColumn (Function)

In french: NotesVueListeColonne

Lists the columns found in the current view in Lotus Notes.

The current view was specified by NotesActivateView.

Example

See additional examples

// Open the connection
ConnectionID is int
ConnectionID = NotesOpenConnection("Password", "MarsServer", ...
"C:\Users\Julia\AppData\Local\Lotus\Notes\Data\user.id")
// Specify the Lotus Notes database to use
DatabaseID is int
DatabaseID = NotesOpenDatabase(ConnectionID, "julia.nsf")
...
// Activate the view
NotesActivateView(DatabaseID, "MyCustomers")
// List the sortable columns found in this view
ListColumn is string
ListColumn = NotesViewListColumn(DatabaseID)
AColumn is string
// For each column
FOR EACH STRING AColumn OF ListColumn SEPARATED BY CR
// Add the characteristics of the column into a List Box control
ListAdd(LIST_ListColumnViews, AColumn)
// For example, the MyColumn column is a sortable Text column
// sorted in ascending order and case sensitive:
// "MyColumn+TAB+notesTypeText+TAB+1+TAB+1+TAB+1+TAB+0"
END

Syntax

<Result> = NotesViewListColumn(<Session identifier> [, <Listed Columns>])

<Result>: Character string

List of columns found in the current view in the following format:

<Name Column 1> + TAB + <Type Column 1> + TAB + <Sortable Column 1> + TAB +
<Sort Direction Column 1> + TAB + <Case Sensibility Column 1> + TAB +
<Accent Sensibility Column 1> + CR + <Name Column 2> + TAB +
<Type Column 2> + TAB + <Sortable Column 2> + TAB + <Sort Direction Column 2> + TAB +
<Case Sensibility Column 2> + TAB + <Accent Sensibility Column 2> +...

Where:
<Name Column X> corresponds to the name of the column.
<Type Column X> corresponds to the type of column. This parameter can correspond to:
notesTypeDateTime: DateTime column.
notesTypeUnknown: Type of column not supported.
notesTypeNumber: Number column.
notesTypeText: Text column.
notesTypeRichText: Rich Text column (containing a formatting and possible attachments).
<Sortable Column X> indicates whether the column is sortable (1) or not (0).
<Sort Direction Column X> indicates whether the column is sorted in ascending order (1) or in descending order (0).
<Case Sensitivity Column X> indicates whether the column is case sensitive (1) or not (0).
<Accent Sensitivity Column X> indicates whether the column is sensitive to the accented characters (1) or not (0).
If <Sortable Column X> corresponds to 0, <Sort Direction Column X>, <Case Sensitivity Column X> and <Accent Sensitivity Column X> must be ignored and they are always set to 0.

<Session identifier>: Integer

Session ID to be used. This identifier is returned by EmailStartNotesSession or NotesOpenDatabase.

<Listed Columns>: Optional integer constant

Selection mode of the listed columns:
notesLstColumnAll Returns all the columns (whether they are sortable or not).
notesLstColumnSortable
(default value) Returns the sortable columns only.

Component: wd280mess.dll