Micro Focus Content Manager SDK 9.3
HP.HPTRIM.SDK.ObjectSelector Class Reference

The ObjectSelector class is used to select one or more objects from a TrimMainObjectList More...

Static Public Member Functions

static TrimMainObject SelectOne (Hwnd parentHWND, TrimMainObjectSearch fromSearch)
 Displays the TRIM tree box allowing the user to choose one of the items in the list. Will return null if the user did not make a selection. More...
 
static TrimMainObjectSearch SelectMany (Hwnd parentHWND, TrimMainObjectSearch fromSearch)
 Displays the TRIM tree box allowing the user to choose one or more items from the supplied list, using the TRIM tag feature. Will return null if the user did not make a selection. More...
 
static void DisplayResults (Hwnd parentHWND, TrimMainObjectSearch fromSearch)
 Displays the TRIM tree box allowing the user to browse the results in the supplied list. More...
 
static bool EditQuery (Hwnd parentHWND, TrimMainObjectSearch fromSearch)
 Displays the TRIM string-based search editor to allow the user to change details of the search More...
 
static bool EditQuery (Hwnd parentHWND, TrimMainObjectSearch fromSearch, bool usePreferredEditor)
 Displays a TRIM Search editor to allow the user to change details of the search. You can allow the user to edit the query using their preferred editor, or simply force the use of the string based editor. Queries that are not editable with the Boolean editor will always be displayed using the editor most suitable. More...
 
static Record SelectContainerRecord (Hwnd parentHWND, Database db, string usingTextAsStartingPoint, Record forContainingThisRecord)
 Displays the TRIM desktop dialog in order that the user can select a container record. You can pass in a record if you wan to ensure that the container is suitable for containing that record (pass NULL otherwise). The function return the container if the user makes a selection, otherwise a NULLvalue is returned. You can seed the search with a record number (or part thereof). More...
 
static bool SetSearchAsUserStartPoint (Hwnd parentHWND, TrimMainObjectSearch searchToSetUp, bool overwriteExistingSearch)
 populates the supplied search object with the default search according to the current user's preference Since one preference involves editing the query, it is possible for the user to cancel out, in which case the function will return false. If you don't specify the overwrite option, the search will only be modified if it contains no existing clauses. More...
 

Protected Attributes

bool swigCMemOwn
 

Detailed Description

The ObjectSelector class is used to select one or more objects from a TrimMainObjectList

Member Function Documentation

static void HP.HPTRIM.SDK.ObjectSelector.DisplayResults ( Hwnd  parentHWND,
TrimMainObjectSearch  fromSearch 
)
static

Displays the TRIM tree box allowing the user to browse the results in the supplied list.

static bool HP.HPTRIM.SDK.ObjectSelector.EditQuery ( Hwnd  parentHWND,
TrimMainObjectSearch  fromSearch 
)
static

Displays the TRIM string-based search editor to allow the user to change details of the search

static bool HP.HPTRIM.SDK.ObjectSelector.EditQuery ( Hwnd  parentHWND,
TrimMainObjectSearch  fromSearch,
bool  usePreferredEditor 
)
static

Displays a TRIM Search editor to allow the user to change details of the search. You can allow the user to edit the query using their preferred editor, or simply force the use of the string based editor. Queries that are not editable with the Boolean editor will always be displayed using the editor most suitable.

static Record HP.HPTRIM.SDK.ObjectSelector.SelectContainerRecord ( Hwnd  parentHWND,
Database  db,
string  usingTextAsStartingPoint,
Record  forContainingThisRecord 
)
static

Displays the TRIM desktop dialog in order that the user can select a container record. You can pass in a record if you wan to ensure that the container is suitable for containing that record (pass NULL otherwise). The function return the container if the user makes a selection, otherwise a NULLvalue is returned. You can seed the search with a record number (or part thereof).

static TrimMainObjectSearch HP.HPTRIM.SDK.ObjectSelector.SelectMany ( Hwnd  parentHWND,
TrimMainObjectSearch  fromSearch 
)
static

Displays the TRIM tree box allowing the user to choose one or more items from the supplied list, using the TRIM tag feature. Will return null if the user did not make a selection.

static TrimMainObject HP.HPTRIM.SDK.ObjectSelector.SelectOne ( Hwnd  parentHWND,
TrimMainObjectSearch  fromSearch 
)
static

Displays the TRIM tree box allowing the user to choose one of the items in the list. Will return null if the user did not make a selection.

static bool HP.HPTRIM.SDK.ObjectSelector.SetSearchAsUserStartPoint ( Hwnd  parentHWND,
TrimMainObjectSearch  searchToSetUp,
bool  overwriteExistingSearch 
)
static

populates the supplied search object with the default search according to the current user's preference Since one preference involves editing the query, it is possible for the user to cancel out, in which case the function will return false. If you don't specify the overwrite option, the search will only be modified if it contains no existing clauses.

Member Data Documentation

bool HP.HPTRIM.SDK.ObjectSelector.swigCMemOwn
protected