IRasPanelNote Interface Reference

Details of an explanatory note on a raster panel. More...

import "_encxcom_encx.idl";

Inheritance diagram for IRasPanelNote:

[legend]

List of all members.

Properties
IPixelRect **	Rect [get]
	The bounding box of the note on the chart. Pixel position (0,0) is always at the top left corner of the chart.
BSTR *	Code [get]
	Fine catIdentification of the note. This is a subsidurary classification within Type().
BSTR *	Type [get]
	Coarse categorisation of the note. E.g. Routeing or Sources.
VARIANT_BOOL *	Obscures [get]
	Returns true if the note overlaps any hydrography.
VARIANT_BOOL *	Display [get]
	Returns true if the note should be displayed to the user.

---

Detailed Description

Details of an explanatory note on a raster panel.

This is a mechanism to enable progamatic access to information that is only available on the chart image. This is typically metadata, such as tidal diamond information, warning notices etc.

Definition at line 1068 of file _encxcom_encx.idl.

---

Property Documentation

IPixelRect ** IRasPanelNote::Rect [get]

The bounding box of the note on the chart. Pixel position (0,0) is always at the top left corner of the chart.

BSTR* IRasPanelNote::Code [get]

Fine catIdentification of the note. This is a subsidurary classification within Type().

For example, the Type() "Buoyage/Beacons/Lights" contains the following Code() values: "Navaids", "IALA Region", "Buoyage changes", "Lights/Beacons".

BSTR* IRasPanelNote::Type [get]

Coarse categorisation of the note. E.g. Routeing or Sources.

VARIANT_BOOL* IRasPanelNote::Obscures [get]

Returns true if the note overlaps any hydrography.

VARIANT_BOOL* IRasPanelNote::Display [get]

Returns true if the note should be displayed to the user.

A few notes are included in the IRasPanelNotes because they obscure hydrography, but are not intended for display to the user.