Common Question 3
How are properties named?
The WinForm and WebForm interfaces use a nested structure of property namespaces to define a property. Refer to the property reference and search the top .NET row header to see the .NET syntax for a property. For example, ViewingStyle has a .NET syntax of PeColor.ViewingStyle.
|
Scope
|
All ProEssentials Objects.
|
|
Type
|
UINT
|
|
Default
|
PEVS_COLOR
|
|
.NET
|
PeColor.ViewingStyle
|
|
Ocx|Vcl
|
ViewingStyle
|
This nested structure breaks up over 1200 features into 13 main categories, all starting with "Pe".
| PeString |
Titles, Labels, and other string type properties. |
| PeData |
Includes properties defining the quantity, attributes, and data-access related features. |
| PeLegend |
Includes properties related to legend, colors, line types, points types, location. |
| PeFont |
Includes all font related properties. |
| PeColor |
Includes all color related properties. |
| PePlot |
Another large nested property including other nested properties to control plotting method access and plotting options. Generally includes everything related to how data is rendered into graphics. |
| PeGrid |
A large nested property including other nested properties to control grid options and grid configuration. Grid configurations deal with quantity and frequency of grid lines. Grid options deal with how grid lines are optionally rendered. |
| PeAnnotation |
Includes other nested properties dealing with graph, line, axis, and table annotations. |
| PeConfigure |
Includes properties controlling visual or functional features global in nature. |
| PeUserInterface |
Includes other nested properties related to menus, dialogs, scrollbars, cursors, and availability of user interface features. |
| PeSpecial |
Includes rarely used features. |
| PeTable |
Unique to the Graph object, includes table related times. |
| PeFunction |
Includes all methods to initialize, reset, export and perform other tasks. |
DLL, OCX, VCL Interfaces
The DLL property reference refers to properties as constants with the "PEP_" prefix. The PEP stands for Pro Essentials Property. Following the PEP_ prefix is a property type declarator. Property prefix meanings are as follows:
|
Prefix
|
Property Type
|
|
PEP_b
|
Boolean (4 bytes)
|
|
PEP_n
|
Integer (4 bytes).
|
|
PEP_dw
|
Double Word (4 bytes)
|
|
PEP_sz
|
Null Terminated array of characters.
|
|
PEP_f
|
Single (4 bytes) or Double (8 bytes) floating point.
|
|
PEP_na
|
Array of Integer (4 bytes)
|
|
PEP_dwa
|
Array of Double Word (4 bytes)
|
|
PEP_sza
|
Array of Null Terminated strings.
|
|
PEP_fa
|
Array of Single (4 bytes) or Double (8 bytes) floating point.
|
|
PEP_struct
|
Various structures
|
If you are using DLL calls to set/get properties. You can use the property prefix to know which function to use.
|
Prefix
|
Property Type
|
|
PEP_b
|
PEnset / PEnget
|
|
PEP_n
|
PEnset / PEnget
|
|
PEP_dw
|
PEnset / PEnget
|
|
PEP_sz
|
PEszset / PEszget.
|
|
PEP_f
|
PEvset / PEvget
|
|
PEP_na
|
PEvset, PEvsetcell, PEvsetcellEx / PEvget, PEvgetcell, PEvgetcellEx
|
|
PEP_dwa
|
PEvset, PEvsetcell, PEvsetcellEx / PEvget, PEvgetcell, PEvgetcellEx
|
|
PEP_sza
|
PEvset, PEvsetcell, PEvsetcellEx / PEvget, PEvgetcell, PEvgetcellEx
|
|
PEP_fa
|
PEvset, PEvsetcell, PEvsetcellEx / PEvget, PEvgetcell, PEvgetcellEx
|
|
PEP_struct
|
PEvset, / PEvget
|
ActiveX/OCX and VCL interfaces strip the property prefix and refer to properties by name alone. This is because DLL functions are not required to set these properties and nomenclature is not as helpful. Any time you see a property with a PEP_ prefix, the OCX/VCL counterpart is just the remainder. For example, the PEP_nVIEWINGSTYLE constant refers to the ViewingStyle OCX/VCL property.
For help finding DLL features, use the Contents Tab at the top-left location within this help system, near the bottom, click Reference, and then Alphabetic Listing.
|
