Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Complex Type: xp:dominoView

Description

Reads a view from a Domino server

Properties

• <xp:dominoView
• categoryFilter
• databaseName
• dataCache
• expandLevel
• ignoreRequestParams
• keys
• keysExactMatch
• loaded
• parentId
• postOpenView
• queryOpenView
• requestParamPrefix
• scope
• search
• searchMaxDocs
• sortColumn
• sortOrder
• startKeys
• var
• viewName
• />

Java

Java Class: com.ibm.xsp.model.domino.DominoViewData

loaded, boolean  [Inherited] Loaded Specifies whether or not the tag instance should be created when the page is loading. Value defaults to 'true'. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

scope, string Scope Defines the scope for referencing this data source Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

ignoreRequestParams, boolean Ignore Request Parameters Ignores Parameters placed on the Request Map Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

requestParamPrefix, string Request Parameter Prefix Prefix which is applied to request parameters for this data source Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

var, string var Request scope attribute under which a data source will be made available Required Attribute true Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

queryOpenView, Query Open View Method Binding Triggered before opening the view Required Attribute false

postOpenView, Post Open View Method Binding Triggered after opening the view Required Attribute false

databaseName, string Database Name The name of the Domino database containing the view data source. Can include the server name or replica id. If not specified then the current database is assumed. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

viewName, string View Name Name of the Domino view to open Required Attribute true Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

categoryFilter, string Category Filter Category filter to be used to restrict the view contents to descendants of this category Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

parentId, string Parent Id The document id of the parent entry whose descendants will populate the retrieved data Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

sortColumn, string Sort Column A column that can be used to sort the view data Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

sortOrder, string Sort Order The order by which you wish to collate the sort column Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

keys, generic Filter Keys A key is used to filter the contents of a view based on the column values. You create a key (or vector of keys if called from JavaScript), where a key corresponds to a value in a sorted column. Results are consistent with getAllDocumentsByKey method in Domino Java API classes. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

keysExactMatch, boolean Filter Using Exact Match Determines whether or not exact matching will be used when the filter key is applied to the view Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

startKeys, generic Start Keys A startKeys is used to define the first row that should be displayed for a view. You create a key (or vector of keys if called from JavaScript), where a key corresponds to a value in a sorted column. The first row is consistent with getEntryByKey method in Domino Java API classes. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

expandLevel, int Expand Level Level of expansion for entries in a hierarchical view. 0 means responses are expanded, 1 means responses are collapsed. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dataCache, string Data Cache Indicates how the data is cached between requests for the same page Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

search, string Search View String Search to perform on view results when displaying in a view control Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

searchMaxDocs, int Maximum Search Documents Maximum number of documents to include in the search result Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true