CNiCaption

CNi

previous page next page
Class CNiCaption Base ClassesData ItemsConstructorsDestructorsFunctionsGo to hierarchy chart    Prev page: SetCoordinatesNext page: Alignment    
Class Declared in:
 NiCaption.h

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

CNiCaption encapsulates the interface to an annotation caption on a graph control, which allows you to modify its appearance and behavior.

You obtain a caption using the Caption property on a CNiAnnotation object.

Note: To specify a date/time value, you must convert your date or time value to a double. A date is implemented as a floating-point value with the integer part of the number measuring days from midnight, 30 December 1899, and the fractional part representing the time of day. The absolute value of the fractional part of the number represents the time as a fraction of a day. Thus, 1 second equals 1 / 24 hours / 60 minutes, which is 1/86400 or approximately 1.157407e-5. So, midnight, 31 December 1899, is represented by 1.0. Similarly, 6 AM, 1 January 1900, is represented by 2.25, and midnight, 29 December 1899, is -1.0. However, 6 AM, 29 December 1899, is -1.25.

Hierarchy Chart Hierarchy Chart

'Base Classes' icon -- Shortcut to top of page. Base Classes

Public base class CNiInterface

'Data Items' icon -- Shortcut to top of page. Data Items

Public data Alignments Alignment Specifies the caption text alignment relative to CNiCaption::XCoordinate and CNiCaption::YCoordinate.
Public data double Angle Angle of the caption text in degrees.
Public data CNiColor Color Specifies the color of the caption.
Public data CNiFont Font Specifies the font of the caption.
Public data CString Text Specifies the the caption text.
Public data double XCoordinate X coordinate of the caption.
Public data double YCoordinate Y coordinate of the caption.

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

Public constructor

CNiCaption()

 Default constructor.
Public constructor

CNiCaption( CWCaption_CI* pCustom, CNiInterface::ThreadAccess option )

 Constructor that attaches to the specified CWCaption_CI pointer.
Public constructor

CNiCaption( const CNiCaption& source )

 Copy constructor.

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

Public destructor

~CNiCaption()

 Destructor.

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

Public function static const IID &

GetIid()

 Returns the globally unique identifier (GUID) of the ActiveX interface to which this class connects.
Public function const CNiCaption &

operator =( const CNiCaption& source )

 Assignment operator.
Public function void

SetCoordinates( double xCoordinate, double yCoordinate )

 Sets the x and y coordinates of the caption at the same time.

Shortcut to top of page. Example

    // Change the text of the first annotation on the graph.

    CNiGraph graph;
    CNiCaption caption = graph.Annotations.Item(1).Caption;
    caption.Text = "Maximum";
previous page start next page