CNiButton::OffImages

CNi

previous page next page
Class
CNiButton::
OffImages() Base ClassesData ItemsConstructorsDestructorsFunctionsGo to hierarchy chart    Prev page: OffImagesNext page: OnImages    
Public Function Declared in:
 NiButton.h

'Declaration' icon -- Shortcut to top of page. Declaration

CNiImage OffImages(
    const CString& imageName);

'Description' icon -- Shortcut to top of page. Description

Gets the image object corresponding to the Off state of the CNiButton control that is associated with the specified part of the CNiButton control.

Notes:

1. You can use the OffImages function to perform operations like loading custom bitmaps and adjusting blink or animation speeds for the button control in the Off state. For example,

    CNiButton1.OffImages("Caption").BlinkInterval = CNiImage::SpeedFast;

causes the button caption to blink quickly when the control is in the Off state. The caption's BlinkInterval property remains unchanged in the On state.

2. Use the OnImages function to control images in the On state.

Shortcut to top of page. Parameters

const CString& imageName

Specifies the name of the image object to return. The list below includes valid image names.

  • CNiButton::Caption
  • CNiButton::Background
  • CNiButton::On Text
  • CNiButton::Off Text
  • CNiButton::Image

'See Also' icon -- Shortcut to top of page. See Also

Class Overview Class Overview  |  Public base class CNiControl  |  Hierarchy Chart Hierarchy Chart

previous page start next page