Smartsite Documentatie > Advanced > Developer > Class Library Reference > Smartsite.FacetedSearch Namespace > QueryBuilderCs Class > QueryBuilderCs Properties
PRELIMINARY INFORMATION - SUBJECT TO CHANGE
This document is provided on an "AS IS" basis without warranties of any kind. Smartsite iXperion class libraries may change in future releases.

Syntax

C# Copy imageCopy Code 
                                  public class QueryBuilderCs
Visual Basic (Declaration) Copy imageCopy Code 
                                  Public Class QueryBuilderCs

The type exposes the following properties.

Public Properties

  Name Description
Public property AcceptsInnerXml
Returns true if the module currently accepts string data within the macro tags.
(Inherited from BaseModule.)
Public property AccessDeniedReturnValue
Gets or sets the value that is returned when the site visitor has insufficient access.
(Inherited from Module.)
Public property AIMMode
Gets or sets the AIM scanning mode of the macro.
(Inherited from Module.)
Public property AIMOrigin
Returns the current AIM source. If AIMMode is Autonomous, the current instructionsource is used, otherwise the current item.
(Inherited from Module.)
Public property Allowemptysearch
Gets or sets the facet.
Public property Assetsearch
Gets or sets the search terms.
Public property BufferNames
Gets or sets the buffer names.
(Inherited from Module.)
Public property ChannelCodes
Sets the channel codes.
Public property Condition
Gets or sets the Viper expression to evaluate before actually executing the macro.
If the expression returns false, the execution of the module and its child modules is skipped.
(Inherited from Module.)
Public property ConditionMatched
Must return true if TestCondition() matched.
(Inherited from Module.)
Public property ConfigurationXml
Gets or sets the configuration XML.
(Inherited from FacetedSearchBase.)
Public property Connection
Gets or sets the connection used for the Sql query.
(Inherited from FacetedSearchBase.)
Public property CurrentCacheModule
Returns a reference to the current cache module, if the current instruction is encapsulated by a cache block.
(Inherited from Module.)
Public property CurrentProperty
Gets the property currently being set on the module.
(Inherited from BaseModule.)
Public property DefaultValue
Gets or sets the default value that will be returned when the execution would otherwise return an empty string.
(Inherited from Module.)
Public property Facet
Gets or sets the facet.
Public property FacetSelectFields
Gets the facet select fields.
Public property FacetValues
Gets or sets the facet values.
Public property FacetWhereClause
Gets the facet-specific where clause.
Public property FieldName
Gets or sets the name of the field.
Public property Filesearch
Gets or sets the search terms.
Public property Formatting
Gets the formatting options.
(Inherited from Module.)
Public property Fulltextoverideset
Gets or sets the fulltext.
(Inherited from FacetedSearchBase.)
Public property HasParameterSection
Returns true if the macro currently uses an SXML parameters section
(Inherited from BaseModule.)
Public property Id
Gets or sets the unique id of the module instance during the current processing.
Modules with Id set will be kept alive during the complete rendering and can be accessed from other modules using the Find method.
(Inherited from BaseModule.)
Public property IsBaseQuery
Gets a value indicating whether this instance is a base (search) query.
Public property IsCancelled
Gets a value indicating whether the execution of the macro is cancelled.
(Inherited from BaseModule.)
Public property IsSelfClosing
Gets a value indicating whether this instance is self closing.
(Inherited from BaseModule.)
Public property JoinClause
Gets the join clause.
Public property LocalId
Gets or sets the local id of the macro in the current buffer scope.
(Inherited from Module.)
Public property MinimumAccessTypeLevel
Friendly name of the minimum access type level required by the site visitor to execute this macro.
(Inherited from Module.)
Public property Mode
Gets or sets the (query) mode.
Public property ModuleInfo
Gets the module info.
(Inherited from BaseModule.)
Public property OnErrorReturnValue
Gets or sets the value to return in case on error occurs during execution.
The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context.
(Inherited from Module.)
Public property OrderBy
Gets or sets the order by clause.
Public property OutputBufferName
Gets or sets the name of the output buffer for storing the datatable (which should be passed to the sqlquery macro).
Public property Properties
Gets the full list of properties as set when executing the module.
(Inherited from BaseModule.)
Public property RankingFields
Gets the ranking fields.
Public property Remarks
Gets or sets the remarks. Remarks have no effect on the actual execution of the module.
They only improve the readability of the code.
(Inherited from BaseModule.)
Public property Result
Returns a reference to the module result
(Inherited from BaseModule.)
Public property ResultChannelCode
Gets the result channel code.
Public property ResultFormat
Gets or sets the resultformat.
(Inherited from Module.)
Public property ResultType
Gets or sets the type of the result.
(Inherited from BaseModule.)
Public property SearchBaseName
Gets or sets the name of the search base.
(Inherited from FacetedSearchBase.)
Public property SearchGroup
Gets or sets the search group.
(Inherited from FacetedSearchBase.)
Public property SearchGroupViewName
Gets the viewname for the search group that has been configured.
Public property SearchProfile
Gets or sets the search profile.
(Inherited from FacetedSearchBase.)
Public property SearchQuery
Gets the search query.
Public property SelectFields
Gets the select fields.
Public property Sources
Gets or sets the sources.
(Inherited from FacetedSearchBase.)
Public property State
Gets a key/value collection that can be used to organize and share data during the lifecycle of a module.
(Inherited from BaseModule.)
Public property Status
Gets a value indicating the ModuleStatus of this module.
(Inherited from BaseModule.)
Public property SXMLPath
Gets the path to the macro in the current execution stack.
(Inherited from BaseModule.)
Public property TableOrView
Gets or sets the (main) table or view for the search query.
Public property TimeoutSeconds
Gets or sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
(Inherited from BaseModule.)
Public property Trim
Gets a value indicating how the whitespace is trimmed.
(Inherited from BaseModule.)
Public property TypeName
Gets the name of the Module type.
(Inherited from BaseModule.)
Public property UserSetPropertyList
Gets the user-set property list.
(Inherited from BaseModule.)
Public property WhereClause
Gets the where clause.
Public property Whitespace
Gets a value indicating whether to preserve whitespace.
(Inherited from BaseModule.)

Protected Properties

  Name Description
Protected property IContext
Gets a reference to the IContext interface.
(Inherited from BaseModule.)

Explicit Interface Implementations

See Also

Advanced