pycatia.in_interfaces.search_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.in_interfaces.search_setting_att.SearchSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
System.SettingController
SearchSettingAtt

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 deep_search_activation: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

bool

property default_power_input_context_priority: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

bool

property default_power_input_context_scope: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Returns:

enum cat_search_context_scope

Return type:

int

property default_power_input_prefix: str

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

str

get_deep_search_activation_info(o_admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
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.
Parameters:

  • o_admin_level (str) –

  • o_locked (str) –

Return type:

bool

get_default_power_input_context_priority_info(o_admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
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.
Parameters:

  • o_admin_level (str) –

  • o_locked (str) –

Return type:

bool

get_default_power_input_context_scope_info(o_admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
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.
Parameters:

  • o_admin_level (str) –

  • o_locked (str) –

Return type:

bool

get_default_power_input_prefix_info(o_admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
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.
Parameters:

  • o_admin_level (str) –

  • o_locked (str) –

Return type:

bool

get_max_displayed_results_info(o_admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
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.
Parameters:

  • o_admin_level (str) –

  • o_locked (str) –

Return type:

bool

get_max_pre_highlighted_elements_info(o_admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
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.
Parameters:

  • o_admin_level (str) –

  • o_locked (str) –

Return type:

bool

property max_displayed_results: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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.
Return type:

int

property max_pre_highlighted_elements: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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.
Return type:

int

set_deep_search_activation_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetDeepSearchActivationLock(boolean iLocked)

Locks or unlocks the Deep Search Activation setting
parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Return type:

None

set_default_power_input_context_priority_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetDefaultPowerInputContextPriorityLock(boolean
iLocked)

Locks or unlocks the Default Power Input Context Priority setting
parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Return type:

None

set_default_power_input_context_scope_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetDefaultPowerInputContextScopeLock(boolean iLocked)

Locks or unlocks the Default Power Input Context Scope setting
parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Return type:

None

set_default_power_input_prefix_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetDefaultPowerInputPrefixLock(boolean iLocked)

Locks or unlocks the Default Power Input Prefix setting
parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Return type:

None

set_max_displayed_results_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetMaxDisplayedResultsLock(boolean iLocked)

Locks or unlocks the Max Displayed Results setting
parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Return type:

None

set_max_pre_highlighted_elements_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetMaxPreHighlightedElementsLock(boolean iLocked)

Locks or unlocks the Max Displayed Results setting
parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Return type:

None