User Tools

Site Tools


api:dk11:net:tatukgis.ndk.tgis_layervector.prepareexportfieldnames_integer_boolean_boolean

Table of Contents

TGIS_LayerVector.PrepareExportFieldNames(int, bool, bool) method

DK11 for .NET | TatukGIS.NDK.TGIS_LayerVector.PrepareExportFieldNames | Overloads | Constructors | Fields | Methods | Properties | Events

Prepare export field names.

Available also on: Delphi | Java | ActiveX.

Syntax

// C#
public void PrepareExportFieldNames(
  int _maxwidth,
  bool _forced,
  bool _useUpperCase
);
' VisualBasic
Public Sub PrepareExportFieldNames(
  ByVal _maxwidth As Integer,
  ByVal _forced As Boolean,
  ByVal _useUpperCase As Boolean
)
// Oxygene
public
  procedure PrepareExportFieldNames(
    _maxwidth : Integer;
    _forced : Boolean;
    _useUpperCase : Boolean
  ); virtual;

Parameters

Name Type Description
_maxwidth int
Integer
max width of field; should be >= 4
_forced bool
Boolean
if _false (default) export names will be constructed for new fields; otherwise saved fields will be ignored
_useUpperCase bool
Boolean
convert field name to uppercase format

Remarks

Use this method to prepare export field names to meet maxwidth criteria. Procedure will also perform basic name adjustment (remove non-ascii letter etc).

If a field name is empty then it will be named to 'FIELD'.

If first letter of the field is not alphanumeric, then the first letter will be changed to 'F'.

If a field is longer then a specified value, then the field will be truncated.

If a field after such changes already exist, then the field will be renamed to nameXX (where XX means 00, 01 etc in hexadecimal).

2018/02/17 00:26