All Frameworks  Object Hierarchy  This Framework  Indexes  Previous Next

SearchSettingAtt (Object)

Represents the setting controller for the Search property tab page.
Role: The setting controller is the object that enables to get and set setting parameters.

Property Index

DeepSearchActivation
Returns or sets the Deep Search Activation attribute.
DefaultPowerInputContextPriority
Returns or sets the Default Power Input Context Priority attribute.
DefaultPowerInputContextScope
Returns or sets the Default Power Input Context Scope attribute.
DefaultPowerInputPrefix
Returns or sets the Default Power Input Prefix attribute.
MaxDisplayedResults
Returns or sets the Max Displayed Results attribute.
MaxPreHighlightedElements
Returns or sets the Max Pre-Highlighted Elements attribute.

Method Index

GetDeepSearchActivationInfo
Retrieves information about the Deep Search Activation setting parameter.
GetDefaultPowerInputContextPriorityInfo
Retrieves information about the Default Power Input Context Priority setting parameter.
GetDefaultPowerInputContextScopeInfo
Retrieves information about the Default Power Input Context Scope setting parameter.
GetDefaultPowerInputPrefixInfo
Retrieves information about the Default Power Input Prefix setting parameter.
GetMaxDisplayedResultsInfo
Retrieves information about the Max Displayed Results setting parameter.
GetMaxPreHighlightedElementsInfo
Retrieves information about the Max Displayed Results setting parameter.
SetDeepSearchActivationLock
Locks or unlocks the Deep Search Activation setting parameter.
SetDefaultPowerInputContextPriorityLock
Locks or unlocks the Default Power Input Context Priority setting parameter.
SetDefaultPowerInputContextScopeLock
Locks or unlocks the Default Power Input Context Scope setting parameter.
SetDefaultPowerInputPrefixLock
Locks or unlocks the Default Power Input Prefix setting parameter.
SetMaxDisplayedResultsLock
Locks or unlocks the Max Displayed Results setting parameter.
SetMaxPreHighlightedElementsLock
Locks or unlocks the Max Displayed Results setting parameter.

Properties


o Property DeepSearchActivation() As boolean
Returns or sets the Deep Search Activation attribute.
Role: The Deep Search Activation attribute manages the Deep Search option available in the Search dialog box used to determine whether documents in visualization mode must be transiently loaded during a search query
o Property DefaultPowerInputContextPriority() As boolean
Returns or sets the Default Power Input Context Priority attribute.
Role: The Default Power Input Context Priority attribute manages whether the default context scope must override the context scope stored in a favorite query
o Property DefaultPowerInputContextScope() As CATSearchContextScope
Returns or sets the Default Power Input Context Scope attribute.
Role: The Default Power Input Context Scope attribute manages the default context scope to be used when none is typed in the Power Input field
o Property DefaultPowerInputPrefix() As CATBSTR
Returns or sets the Default Power Input Prefix attribute.
Role: The Default Power Input Prefix attribute manages the default prefix to be used when none is typed in the Power Input field
o Property MaxDisplayedResults() As long
Returns or sets the Max Displayed Results attribute.
Role: The Max Displayed Results attribute indicates the maximum number of elements that can be displayed in the Search results page. Displaying too many lines can stick more or less the results list so it is recommended to limit this number.
o Property MaxPreHighlightedElements() As long
Returns or sets the Max Pre-Highlighted Elements attribute.
Role: The Max Pre-Highlighted Elements attribute indicates the maximum number of elements that can be displayed in the Search results page. Displaying too many elements can stick the session so it is strongly recommended to limit this number.

Methods


o Func GetDeepSearchActivationInfo(CATBSTR oAdminLevel,
CATBSTR oLocked) As boolean
Retrieves information about the Deep Search Activation setting parameter.
Refer to SettingController for a detailed description.
o Func GetDefaultPowerInputContextPriorityInfo(CATBSTR oAdminLevel,
CATBSTR oLocked) As boolean
Retrieves information about the Default Power Input Context Priority setting parameter.
Refer to SettingController for a detailed description.
o Func GetDefaultPowerInputContextScopeInfo(CATBSTR oAdminLevel,
CATBSTR oLocked) As boolean
Retrieves information about the Default Power Input Context Scope setting parameter.
Refer to SettingController for a detailed description.
o Func GetDefaultPowerInputPrefixInfo(CATBSTR oAdminLevel,
CATBSTR oLocked) As boolean
Retrieves information about the Default Power Input Prefix setting parameter.
Refer to SettingController for a detailed description.
o Func GetMaxDisplayedResultsInfo(CATBSTR oAdminLevel,
CATBSTR oLocked) As boolean
Retrieves information about the Max Displayed Results setting parameter.
Refer to SettingController for a detailed description.
o Func GetMaxPreHighlightedElementsInfo(CATBSTR oAdminLevel,
CATBSTR oLocked) As boolean
Retrieves information about the Max Displayed Results setting parameter.
Refer to SettingController for a detailed description.
o Sub SetDeepSearchActivationLock(boolean iLocked)
Locks or unlocks the Deep Search Activation setting parameter.
Refer to SettingController for a detailed description.
o Sub SetDefaultPowerInputContextPriorityLock(boolean iLocked)
Locks or unlocks the Default Power Input Context Priority setting parameter.
Refer to SettingController for a detailed description.
o Sub SetDefaultPowerInputContextScopeLock(boolean iLocked)
Locks or unlocks the Default Power Input Context Scope setting parameter.
Refer to SettingController for a detailed description.
o Sub SetDefaultPowerInputPrefixLock(boolean iLocked)
Locks or unlocks the Default Power Input Prefix setting parameter.
Refer to SettingController for a detailed description.
o Sub SetMaxDisplayedResultsLock(boolean iLocked)
Locks or unlocks the Max Displayed Results setting parameter.
Refer to SettingController for a detailed description.
o Sub SetMaxPreHighlightedElementsLock(boolean iLocked)
Locks or unlocks the Max Displayed Results setting parameter.
Refer to SettingController for a detailed description.

Copyright © 2003, Dassault Systèmes. All rights reserved.