WpSetIconTextVisibility

This method is specific to Version 4, or higher, of the OS/2 operating system.

This instance method sets the icon text visibility for the specified view.

Syntax

wpSetIconTextVisibility(somSelf, ulOption, ulView, fRefreshViews)

Parameters

somSelf (WPFolder *) - input

Pointer to the object on which the method is being invoked.

Points to an object of class WPFolder.

ulOption (ULONG) - input

The visibility state.

• **0** Makes the icon text not visible.
• **ICON_TEXT_VISIBLE** Makes the icon text visible.
• **USE_GLOBAL_VISIBILITY** Uses the global value.

ulView (ULONG) - input

Specifies which view to query.

• **OPEN_CONTENTS** Opens the Contents view.
• **OPEN_DEFAULT** Opens the default view (same as double-clicking).
• **OPEN_DETAILS** Opens the Details view.
• **OPEN_HELP** Displays the help panel.
• **OPEN_RUNNING** Executes the object.
• **OPEN_SETTINGS** Opens the Settings notebook.
• **OPEN_TREE** Opens the Tree view.
• **OPEN_USER** Class-specific views have a greater value than this.

fRefreshViews (BOOL) - input

Refresh open views flag.

• **TRUE** Refresh all open views.
• **FALSE** Does not refresh the open views.

Returns

rc (none) - returns

There is no return value for this method.

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to indicate whether or not the titles are displayed in **Icon** or **Tree View** of a folder.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPFolder *somSelf; /* Pointer to the object on which the method is being invoked. */
ULONG ulOption; /* The visibility state. */
ULONG ulView; /* Specifies which view to query. */
BOOL fRefreshViews; /* Refresh open views flag. */

wpSetIconTextVisibility(somSelf, ulOption,
        ulView, fRefreshViews);

/* Example code provided in the source: */
    _wpSetIconTextVisibility(somSelf,ICON_TEXT_VISIBLE);

Related Methods

• wpQueryIconTextBackgroundColor
• wpQueryIconTextColor
• wpQueryIconTextVisibility
• wpQueryShadowTextColor
• wpSetIconTextBackgroundColor
• wpSetIconTextColor
• wpSetShadowTextColor