SearchResultForCategories Properties Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

The SearchResultForCategories type exposes the following members.

Properties

  Name Description
Public property BackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public property ColProperties
Sets or gets the collection of COL elements for the generated table. The default value is an empty string.
Public property ComponentName
Gets the name of the component.
(Overrides ActiveScriptingBaseComponentName.)
Public property Conformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Public property ContainerListType
Gets a value that indicates the type of container to search in. The default value is FulltextSearch.ContainerListTypes.Unit.
Public property Criteria
Gets the search criteria that is used.
Public property DateFormattingString
Sets or gets a value that indicates how DateTime values should be formatted. The default value is an empty string (using the default format of the system). For a more information on the different date format strings see the DateTimeFormatInfo class documentation.
Public property DisplayCreatedDate
Sets or gets a value that indicates if the Created Date column should be displayed. The default is false.
Public property DisplayLogicalPath
Sets or gets a value that indicates if the Logical path column should be displayed. The default is false.
Public property DisplayRelevance
Sets or gets a value that indicates if the column with relevance information should be displayed. The default is true.
Public property ElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public property Encoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public property ExtendedSearchResultClassName
Sets or gets a value that contains the CSS class name of the extended search result formatting. The default is an empty string.
Public property HideIntroduction
Sets or gets a value that indicates if the Introduction columns should be hidden. The default is false.
Public property LanguageID
Gets or sets the language to use while fulltext searching.
Note Note
This property is ignored when Content Studio uses SQL Server 2000.
Public property LBLLeadingPageRangeText
Sets or gets the leading text to display in the paging information. The default value is an empty string.
Public property LBLLinkPrefix
Sets or gets link prefix text of the paging information. The default value is an empty string, which will render page numbers only.
Public property LBLNextPage
Sets or gets the text for next page in the paging information. The default value is a "greater than" sign (">").
Public property LBLNextRange
Sets or gets the text for next range in the paging information. The default value is two "greater than" signs (">>").
Public property LBLPrevPage
Sets or gets the text for previous page in the paging information. The default value is a "less than" sign ("<").
Public property LBLPrevRange
Sets or gets the text for the previous range in the paging information. The default value is two "less than" signs ("<<").
Public property LinkAttributes
Sets or gets the link attributes.
Public property LinkSep
Sets or gets a value used as link separator text. The default value is a non-breaking space (" ").
Public property MaxReturnSize
Sets or gets the maximum number of rows to be returned. The default value is 200.
Public property PageSize
Sets or gets the number of rows on each page. Setting this property to zero will list all documents on the same page. The default value is 4.
Public property PostMode
Sets or gets a value that indicates how posted pages should be handled. The default value is PostMode.No.
Public property PresentationTemplateId
Sets or gets the presentation template ID to use. The default value is zero (no presentation template is used).
Public property RangePosition
Sets or gets a value that indicates where the page range should be placed in relation to the generated table. The default value is RangePositions.Bottom.
Public property RangeSize
Sets or gets the number if page references to display in the paging information. The default value is 10
Public property RankAltText
Sets or gets the ALT text for ranking images. The default value is "Rank".
Public property ResultStr0
Sets or gets the message to show if the search condition could not be evaluated. The default value is "<b>Your search criteria was too general</b>".
Public property ResultStr1
Sets or gets the first portion of the summary text displayed if no data could be found. This value will be followed by the entered criteria. The default value is "<b>Your search for </b>".
Public property ResultStr2
Sets or gets the end portion of the summary text if no data could be found. The default value is "<b> did not match any documents.</b>".
Public property ResultStr3
Sets or gets the first portion of the summary text when data has been found. The default value is "<b>Search result for:</b>".
Public property ResultStr4
Sets or gets the title of the Document column. The default value is "<b>Document</b>".
Public property ResultStr5
Sets or gets the name of the Relevance column. The default value is "<b>Relevance</b>".
Public property ResultStr6
Sets or gets the name of the Logical path column. The default value is "<b>Path</b>".
Public property ResultStr7
Sets or gets the name of the date column. The default value is "<b>Date</b>".
Public property ReturnFieldsInExtendedSearchResult
Sets or gets the names of the EPT fields to be returned in the extended search result. Use "," (comma) as a separator. The default is an empty string.
Public property RowColor1
Sets or gets the background color of odd numbered rows (1, 3 etc.). The default value is "#FFFFFF" (white).
Public property RowColor2
Sets or gets the background color of even numbered rows (2,4 etc.). The default value is "#F5F5F5" (light grey).
Public property SearchContainers
Gets the containers that are used. This value is calculated in the object constructor.
Public property SearchMethod
Sets or gets a value that specifies the search method to use.
Note Note
This property is ignored when Content Studio uses SQL Server 2000.
Public property SearchOptions
Sets or gets a value that specifies special options to use during search.
Note Note
This property is ignored when Content Studio uses SQL Server 2000.
Public property SortableColumns
Sets or gets a value that indicates if the user should be able to sort the data. The default is false.
Public property SortOrder
Sets or gets a value that indicates how the search result should be sorted. The default value is FulltextSearch.SortOrder.Rank. This is a dynamic property that will be maintained by the component depending on the behavior of the user.
Public property TableAttributes
Sets or gets table attributes. The default value is an empty string.
Public property TableBorder
Sets or gets the table border width. The default value is zero (no border).
Public property TableCellPadding
Sets or gets the table cell padding. The default value is 3.
Public property TableCellSpacing
Sets or gets the table cell spacing. The default value is zero.
Public property TableClassName
Sets or gets the CLASS attribute of the generated table. The default value is an empty string, which omits the attribute.
Public property TableSummary
Sets or gets the SUMMARY attribute of the generated table. The default value is an empty string, which omits the attribute. Omitting this attribute causes validation warnings for XHTML 1.0 strict or higher.
Public property TableWidth
Sets or gets the WIDTH attribute of the generated table. The default value is "100%".
Public property Target
Sets or gets the TARGET attribute for each generated link in the result set. The default is an empty string.
Public property UseExtendedSearchResult
Sets or gets a value that indicates if the extended search result should be used. This functionality, if available, displays a short summary of found data. The default is false.
Top
See Also

Reference