DK for .NET | TatukGIS.NDK.TGIS_ConfigXml | Classes | Constructors | Fields | Methods | Properties
XML-backed configuration class for layer settings and related data.
// C# public class TGIS_ConfigXml : TGIS_Config { }
' VisualBasic Public Class TGIS_ConfigXml Inherits TGIS_Config End Class
// Oxygene type TGIS_ConfigXml = public class( TGIS_Config ) end;
→ TGIS_BaseObjectDisposable → TGIS_ConfigAbstract → TGIS_Config
| Name | Visibility | Description | |
|---|---|---|---|
| TGIS_ConfigXml() | public | Creates a configuration wrapper for a layer or project file. (Overrides TGIS_Config.TGIS_Config()) |
|
| Name | Visibility | Description | |
|---|---|---|---|
| FConfigFormat | protected | Actual config format. (Inherited from TGIS_Config) |
|
| FConfigPath | protected | Path for config file. (Inherited from TGIS_Config) |
|
| FMustSave | protected | True if config should be saved. (Inherited from TGIS_Config) |
|
| FVersion | protected | Config version number. (Inherited from TGIS_Config) |
|
| Name | Visibility | Description | |
|---|---|---|---|
| AbsolutePath | public | Computes an absolute path from a path relative to the configuration file. (Inherited from TGIS_Config) |
|
| AddSubLayer | public | Adds a sublayer entry to the configuration. (Overrides TGIS_Config.AddSubLayer) |
|
| BuildProject | public | Build a project config from the current project and layers attached to the viewer. (Inherited from TGIS_Config) |
|
| ClearActiveSection | public | Deletes elements related to the current active section. (Overrides TGIS_Config.ClearActiveSection) |
|
| ClearGroups | public | Deletes group sections related to the selected group. (Overrides TGIS_Config.ClearGroups) |
|
| ClearSave | public | Clears the (Inherited from TGIS_Config) |
|
| ClearSections | public | Deletes sections related to the selected layer. (Overrides TGIS_Config.ClearSections) |
|
| ClearSubSections | public | Deletes subsections related to the selected layer. (Overrides TGIS_Config.ClearSubSections) |
|
| clearZones | protected | Clears all values stored for the named zone. (Overrides TGIS_Config.clearZones) |
|
| GetStrings | public | Fills a string list with values parsed from the config. (Overrides TGIS_Config.GetStrings) |
|
| Lock | public | Locks the configuration so MustSave is evaluated on Unlock. (Overrides TGIS_Config.Lock) |
|
| LockThread | public | Locks config operations to the current thread only. (Inherited from TGIS_Config) |
|
| Read3DLayerType | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadAlignment | public | Reads a label alignment value from the active section. (Inherited from TGIS_Config) |
|
| ReadBasement | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadBitmap | public | Reads a bitmap value from the active section. (Inherited from TGIS_Config) |
|
| ReadBoolean | public | Reads a Boolean value from the active section. (Inherited from TGIS_Config) |
|
| ReadChart | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadColor | public | Reads a color value from the active section. (Inherited from TGIS_Config) |
|
| ReadColorInterpolationMode | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadColorRamp(string, TGIS_ColorMap[]) | public | Read a deprecated color ramp parameter by name. (Inherited from TGIS_Config) |
|
| ReadColorRamp(string, TGIS_GradientMap) | public | Read a color ramp parameter by name. (Inherited from TGIS_Config) |
|
| ReadCustomData | public | Read custom configuration parameters. (Inherited from TGIS_Config) |
|
| readCustomParam | protected | Reads values from a custom configuration section. (Overrides TGIS_Config.readCustomParam) |
|
| ReadDormant | public | Reads a layer dormant mode value from the active section. (Inherited from TGIS_Config) |
|
| ReadFloat | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadFontStyle | public | Reads a font style set from the active section. (Inherited from TGIS_Config) |
|
| ReadGround | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadHierarchyGroups | public | Reads hierarchy groups from the config. (Inherited from TGIS_Config) |
|
| ReadInteger | public | Reads an integer value from the active section. (Inherited from TGIS_Config) |
|
| ReadInterpretation | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadMarker | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadNormalized | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadOffsetPosition | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| readParam | protected | Reads a configuration parameter from the active section. (Overrides TGIS_Config.readParam) |
|
| ReadPattern | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadPen | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadPosition | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadSectionValues | public | Reads all values from the named section into a list. (Overrides TGIS_Config.ReadSectionValues) |
|
| ReadString | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadSymbol | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
| ReadZone(string, TGIS_PixelZoneListAbstract) | public | Read parameters given by zone _name. (Inherited from TGIS_Config) |
|
| ReadZone(string, TStringList) | public | Read parameters given by zone _name. (Inherited from TGIS_Config) |
|
| readZones(string, TGIS_PixelZoneListAbstract) | protected | Reads zone values into a pixel-zone list. (Overrides TGIS_Config.readZones) |
|
| readZones(string, TStringList) | protected | Reads zone values into a string-based zone list. (Overrides TGIS_Config.readZones) |
|
| RelativePath | public | Computes a path relative to the configuration file. (Inherited from TGIS_Config) |
|
| Reread | public | Reread configuration file. (Overrides TGIS_Config.Reread) |
|
| Save | public | Saves the configuration file and its backup copy. (Overrides TGIS_Config.Save) |
|
| SetGroup | public | Selects the group whose configuration section will be used. (Overrides TGIS_Config.SetGroup) |
|
| SetGroupSection | public | Selects the active group section for subsequent operations. (Overrides TGIS_Config.SetGroupSection) |
|
| SetLayer | public | Selects the layer whose configuration section will be used. (Overrides TGIS_Config.SetLayer) |
|
| SetSection | public | Selects the active section for subsequent operations. (Overrides TGIS_Config.SetSection) |
|
| SetStrings | public | Parses values from a string list and stores them in the config. (Overrides TGIS_Config.SetStrings) |
|
| SetSubLayer | public | Selects the sublayer whose configuration section will be used. (Overrides TGIS_Config.SetSubLayer) |
|
| SetSubSection | public | Selects the active subsection for subsequent operations. (Overrides TGIS_Config.SetSubSection) |
|
| Unlock | public | Unlocks the configuration and evaluates the actual MustSave state. (Overrides TGIS_Config.Unlock) |
|
| UnlockThread | public | Unlocks config operations previously locked by (Inherited from TGIS_Config) |
|
| Write3DLayerType | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteAlignment | public | Writes a label alignment value to the active section. (Inherited from TGIS_Config) |
|
| WriteBasement | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteBitmap | public | Writes a bitmap value to the active section. (Inherited from TGIS_Config) |
|
| WriteBoolean | public | Writes a Boolean value to the active section. (Inherited from TGIS_Config) |
|
| WriteChart | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteColor | public | Writes a color value to the active section. (Inherited from TGIS_Config) |
|
| WriteColorInterpolationMode | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteColorRamp(string, TGIS_ColorMap[], TGIS_ColorMap[]) | public | Write a deprecated color ramp parameter by name. (Inherited from TGIS_Config) |
|
| WriteColorRamp(string, TGIS_GradientMap, TGIS_GradientMap) | public | Write a color ramp parameter by name. (Inherited from TGIS_Config) |
|
| WriteCustomData | public | Write custom configuration parameters. (Inherited from TGIS_Config) |
|
| writeCustomParam | protected | Writes values to a custom configuration section. (Overrides TGIS_Config.writeCustomParam) |
|
| WriteDormant | public | Writes a layer dormant mode value to the active section. (Inherited from TGIS_Config) |
|
| WriteFloat | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteFontStyle | public | Writes a font style set to the active section. (Inherited from TGIS_Config) |
|
| WriteGround | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteHierarchyGroups | public | Write hierarchy groups to the config. (Inherited from TGIS_Config) |
|
| WriteInteger | public | Writes an integer value to the active section. (Inherited from TGIS_Config) |
|
| WriteInterpretation | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteMarker | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteNormalized | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteOffsetPosition | public | Writes an offset position parameter identified by (Inherited from TGIS_Config) |
|
| writeParam | protected | Writes a configuration parameter to the active section. (Overrides TGIS_Config.writeParam) |
|
| WritePattern | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WritePen | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WritePosition | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteString | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteStyle | public | Write a style parameter by name. (Inherited from TGIS_Config) |
|
| WriteSymbol | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
| WriteZone(string, TGIS_PixelZoneListAbstract, TGIS_PixelZoneListAbstract) | public | Write parameters given by zone _name. (Inherited from TGIS_Config) |
|
| WriteZone(string, TStringList, TStringList) | public | Write parameters given by zone _name. (Inherited from TGIS_Config) |
|
| writeZones(string, TGIS_PixelZoneListAbstract, TGIS_PixelZoneListAbstract) | protected | Writes zone values from a pixel-zone list. (Overrides TGIS_Config.writeZones) |
|
| writeZones(string, TStringList, TStringList) | protected | Writes zone values from a string-based zone list. (Overrides TGIS_Config.writeZones) |
|
| Name | Visibility | Description | |
|---|---|---|---|
| ConfigFormat | public | Gets the internal config format. (Inherited from TGIS_Config) |
|
| FileName | public | Gets the configuration file name. (Inherited from TGIS_Config) |
|
| IniObj | public | Underlying XML file object used for configuration storage. | |
| IsProject | public | True if the config represents a project. (Inherited from TGIS_Config) |
|
| IsShapeStyle | public | True if config is for shape style embedding. (Inherited from TGIS_Config) |
|
| MustSave | public | True if the config has been changed. (Inherited from TGIS_Config) |
|
| PrjLayerConfig | public | Config file name without extension for the layer at a given index in a project file. (Inherited from TGIS_Config) |
|
| PrjLayerName | public | Returns the name of the layer at the specified index in a project file. (Inherited from TGIS_Config) |
|
| PrjLayerPath | public | Returns the path of the layer at the specified index in a project file. (Inherited from TGIS_Config) |
|
| PrjLayersCount | public | Returns the number of layers defined in the project config file. (Inherited from TGIS_Config) |
|
| Section | public | Overrides the current section used for config read and write operations. (Inherited from TGIS_Config) |
|
| UseRelativePath | public | If True, file paths are saved relative to the config file location. (Inherited from TGIS_Config) |
|
| Version | public | Gets the config version number. (Inherited from TGIS_Config) |
|
| WriteFull | public | If True, all config keys are saved; otherwise only changed keys are saved. (Inherited from TGIS_Config) |
|
Each layer can have its own configuration file located in the same directory as the layer data itself. This file must have the name “layerfile_with_extension.ttkstyle”. Below you can see a sample file :
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <TatukGIS> <Layer> <Sections> <Section> <Visible>YES</Visible> <Ground>OnDem</Ground> <Line> <OutlineWidth>SIZE:0 twips</OutlineWidth> </Line> <Area> <Color>ARGB:FFF7EFEF</Color> <OutlineWidth>SIZE:24 twips</OutlineWidth> <SmartSize>SIZE:16 twips</SmartSize> <ShowLegend>YES</ShowLegend> </Area> <Active>YES</Active> <Caption>Country area</Caption> <CodePage>1250</CodePage> <CS> <EPSG>4326</EPSG> </CS> <IgnoreShapeParams>YES</IgnoreShapeParams> </Section> </Sections> </Layer> </TatukGIS>
Warning! Format modified in v11.8.0. Files .ttkstyle written in versions prior to 11.8.0 should be modified manually to match current specification.
Is very similar to layer configuration file. Values written to this file will overwrite values from layer configuration file. Below you can see a sample file :
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <TatukGIS> <Viewer> <VisibleExtent> <XMin>13.5683080162247</XMin> <XMax>24.6619641937987</XMax> <YMin>46.38677912557</YMin> <YMax>57.480435303144</YMax> </VisibleExtent> <CS> <EPSG>4326</EPSG> </CS> </Viewer> <Layers> <Layer Name="Country area" Path="country.shp"> <Sections> <Section> <Visible>YES</Visible> <Ground>OnDem</Ground> <Line> <OutlineWidth>SIZE:0 twips</OutlineWidth> </Line> <Area> <Color>ARGB:FFF7EFEF</Color> <OutlineWidth>SIZE:24 twips</OutlineWidth> <SmartSize>SIZE:16 twips</SmartSize> <ShowLegend>YES</ShowLegend> </Area> <Active>YES</Active> <Caption>Country area</Caption> <CodePage>1250</CodePage> <CS> <EPSG>4326</EPSG> </CS> <IgnoreShapeParams>YES</IgnoreShapeParams> </Section> </Sections> </Layer> </Layers> <Hierarchy> <Groups> <Group Name="Group1" Caption="Poland" Collapsed="False" Active="True"> <Group Name="Group5" Caption="Borders" Collapsed="False" Active="True"> <Layers> <Layer Name="Country area"/> </Layers> </Group> </Group> </Groups> </Hierarchy> </TatukGIS>