HoconConfigurationElement Class

This class represents a custom HOCON (Human-Optimized Config Object Notation) node within a configuration file.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="akka" type="Akka.Configuration.Hocon.AkkaConfigurationSection, Akka" />
  </configSections>
  <akka>
    <hocon>
    ...
    </hocon>
  </akka>
</configuration>

Inheritance Hierarchy

SystemObject
  System.ConfigurationConfigurationElement
    Akka.Configuration.HoconCDataConfigurationElement
      Akka.Configuration.HoconHoconConfigurationElement

Namespace: Akka.Configuration.Hocon
Assembly: Akka (in Akka.dll) Version: 1.2.3.129 (1.2.3.129)

Syntax

Copy

public class HoconConfigurationElement : CDataConfigurationElement

type HoconConfigurationElement =  
    class
        inherit CDataConfigurationElement
    end

The HoconConfigurationElement type exposes the following members.

Constructors

	Name	Description
	HoconConfigurationElement	Initializes a new instance of the HoconConfigurationElement class

Top

Properties

	Name	Description
	Content	Gets or sets the HOCON configuration string contained in the hocon node.
	CurrentConfiguration	Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
	ElementInformation	Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
	ElementProperty	Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
	EvaluationContext	Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.)
	HasContext	Gets a value that indicates whether the CurrentConfiguration property is null. (Inherited from ConfigurationElement.)
	ItemConfigurationProperty	Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
	ItemString	Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
	LockAllAttributesExcept	Gets the collection of locked attributes. (Inherited from ConfigurationElement.)
	LockAllElementsExcept	Gets the collection of locked elements. (Inherited from ConfigurationElement.)
	LockAttributes	Gets the collection of locked attributes (Inherited from ConfigurationElement.)
	LockElements	Gets the collection of locked elements. (Inherited from ConfigurationElement.)
	LockItem	Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
	Properties	Gets the collection of properties. (Inherited from ConfigurationElement.)

Top

Methods

	Name	Description
	DeserializeElement	Deserializes the text located in a CDATA node of the configuration file. (Inherited from CDataConfigurationElement.)
	Equals	Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.)
	GetTransformedAssemblyString	Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement.)
	GetTransformedTypeString	Returns the transformed version of the specified type name. (Inherited from ConfigurationElement.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Init	Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
	InitializeDefault	Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
	IsModified	Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.)
	IsReadOnly	Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
	ListErrors	Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnDeserializeUnrecognizedAttribute	Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement.)
	OnDeserializeUnrecognizedElement	Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement.)
	OnRequiredPropertyNotFound	Throws an exception when a required property is not found. (Inherited from ConfigurationElement.)
	PostDeserialize	Called after deserialization. (Inherited from ConfigurationElement.)
	PreSerialize	Called before serialization. (Inherited from ConfigurationElement.)
	Reset	Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.)
	ResetModified	Resets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.)
	SerializeElement	Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
	SerializeToXmlElement	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
	SetPropertyValue	Sets a property to the specified value. (Inherited from ConfigurationElement.)
	SetReadOnly	Sets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unmerge	Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)

Top

Extension Methods

	Name	Description
	AsInstanceOfT	TBD (Defined by Extensions.)
	Match	Overloaded. Matches the specified target. (Defined by PatternMatch.)
	MatchT	Overloaded. Matches the specified target and return a result of target processing. (Defined by PatternMatch.)

Top

Reference

Akka.Configuration.Hocon Namespace