All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

InteractiveInterfaces Interface CATIIniSearchVisibilityCriterion

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---InteractiveInterfaces.CATIIniSearchCriterion
        |
        +---CATIIniSearchVisibilityCriterion
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIIniSearchVisibilityCriterion

Interface to define a visibility-based criterion.
Role: This interface enables the complete definition of a search criterion on the visibility graphic attribute.
The objects found will match the visibility and operating sign, as specified in the SetParameters method.
Objects that do not have this graphic attribute are excluded from the search results, whatever is the chosen operating sign.


Method Index


o SetParameters(CATIIniSearchVisibilityCriterion::ShowAttribut,CATIniSearchEnumeration::Comparison)
Sets the visibility parameter using an enumeration value.
o SetParameters(CATUnicodeString&,CATIniSearchEnumeration::Comparison)
Sets the visibility parameter using a character string.

Enumerated Type Index


o ShowAttribut
Enumeration of available visibility types.

Methods


o SetParameters
public virtual HRESULT SetParameters(CATIIniSearchVisibilityCriterion::ShowAttribut iVisible,
CATIniSearchEnumeration::Comparison iOperatingSign) = 0
Sets the visibility parameter using an enumeration value.
Role: This method sets the visibility parameter thanks to an enumeration representing the visibility status.
Parameters:
iVisible
The enumeration representing the visibility status.
iOperatingSign
The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
Returns:
E_FAIL if the criterion is not correctly set up.
S_OK otherwise.
o SetParameters
public virtual HRESULT SetParameters( const CATUnicodeString& iVisibilityString,
CATIniSearchEnumeration::Comparison iOperatingSign) = 0
Sets the visibility parameter using a character string.
Role: This method sets the visibility parameter thanks to a CATUnicodeString representing the visibility status.
Parameters:
iVisibilityString
The string representing the visibility status. The case used is not important.
It can either be the transformat values visible or hidden
or, the user can use a language specific name (displayed in the Edit/Search user interface). However the criterion would then only work in an application session using this language.
iOperatingSign
The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
Returns:
E_FAIL if the criterion is not correctly set up.
S_OK otherwise.

Enumerated Types


o ShowAttribut
enum ShowAttribut {
  CATShowAttr,
  CATNoShowAttr
}
Enumeration of available visibility types.
The following types are allowed:
Parameters:
CATShowAttr
for objects that are visible.
CATNoShowAttr
for objects that are invisible.

This object is included in the file: CATIIniSearchVisibilityCriterion.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces

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