beautypg.com

Container, Currentformatlocale, Currentformatlocale p – Echelon OpenLNS User Manual

Page 713

background image

OpenLNS Programmer's Reference

676

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

Container

Summary

This is a standard ActiveX control property used for visual

controls. This property is not applicable for the Object

Server

.

CurrentFormatLocale

Summary

Determines which

FormatLocale

object will be used by your

application as the active

FormatLocale.

Each FormatLocale object contains a group of properties that

reflect a particular geographical area’s conventions for data

display. These properties determine how data stored in the

FormattedValue properties of DataPoint objects will be

displayed when that FormatLocale is used by an application.

The CurrentFormatLocale property determines which

FormatLocale object will be used by your application as the

active FormatLocale.
The FormatLocales collection object contains all the

FormatLocale objects that have been added to the Object

Server. This includes four pre-defined FormatLocale objects.
The default setting for this property is the

"

UserDefaultRegionalSettings"

FormatLocale

object, which

uses collection index number 1. For a description of this and

the other pre-defined Format Locales, see the

FormatLocales

collection object.
Note: You can not write to this property, or write to the

FormatLocale object assigned to this property after you have

opened a network and formatted data with your application.

Operations that will cause your application to format data

include acquiring a DataPoint object, and reading or writing

the value of a ConfigProperty or NetworkVariable object. If

you write to the CurrentFormatLocale property after

performing any of these operations, the LCA, #122

lcaErrReadOnlyInContext exception will be thrown. In

addition, you can only access this property after you have

opened

the Object Server.

Availability

Local, full, lightweight, and independent clients.

Syntax

objectServer.

CurrentFormatLocale

= formatLocale

Element

Description

objectServer

The

ObjectServer

object being acted

upon.

formatLocale

The

FormatLocale

object to be used by

the application.