Click or drag to resize

PFSSection Class

A PFSSection object represents a section in a PFS file.

A PFSSection can have other sections and keywords inside it.

Inheritance Hierarchy
SystemObject
  DHI.PFSPFSSection

Namespace:  DHI.PFS
Assembly:  DHI.PFS (in DHI.PFS.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class PFSSection

The PFSSection type exposes the following members.

Constructors
  NameDescription
Public methodPFSSection
Initialize a new PFSSection with the given pfsNode pointer.
Top
Properties
  NameDescription
Public propertyItemInt32 Obsolete.
Get the section at the specified index.

Short of GetSection(Int32), as in

GetSection(sectionIndex+1);

Public propertyItemString
Get the first section with the specified name

Short of GetSection(String, Int32, Boolean) as

GetSection(sectionName, 1, false);

Public propertyItemString, Int32
Get the n'th section with the specified name

Short of GetSection(String, Int32, Boolean) as

GetSection(sectionName, sectionNameIndex+1, false);

Public propertyName
Name of section.
Top
Methods
  NameDescription
Public methodDeleteKeyword(Int32)
Delete a keyword from this section by keyword number

To delete the first keyword in the section, use

section.DeleteKeyword(1)

Public methodDeleteKeyword(String, Int32)
Delete a keyword from this section by keyword name and named index

To delete the first keyword with some name, use

section.DeleteKeyword("keywordName", 1)

Public methodDeleteSection(Int32)
Delete a section from this section object by section index
Public methodDeleteSection(String, Int32)
Delete a section from this section object by section name and named index
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFindSection
Find the first section with the given name.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInstanceNo Obsolete.
Internal method, for testing/debugging only
Public methodGetInternalPfsNodePointer
Get the underlying internal PFS node pointer.

For internal use only

Public methodGetKeyword(Int32)
Get the keyword at the specified position.
Public methodGetKeyword(String)
Get the first keyword with the specified name.
Public methodGetKeyword(String, Int32)
Get the n'th keyword instance with the specified name.
Public methodGetKeyword(String, Int32, Boolean)
Get the n'th keyword instance with the specified name.
Public methodGetKeywordsCount
Get the number of keywords in this section
Public methodGetKeywordsCount(String)
Get the number of keywords in this section matching KeywordName
Public methodGetSection(Int32)
Get the section at the specified position.

To get the first section, use

section.GetSection(1);

Public methodGetSection(String, Int32)
Get the n'ths section instance with the specified name

To get the first section of a certain name, use

section.GetSection("sectionName", 1);

Public methodGetSection(String, Int32, Boolean)
Get the n'ths section instance with the specified name.

To get the first section of a certain name, use

section.GetSection("sectionName", 1, true);

Public methodGetSectionsCount
Get the number of sub-sections within this section
Public methodGetSectionsCount(String)
Get the number of sub-section of this section with the specified section name.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInsertNewKeyword
Insert a new keyword with specified name into this section object

To Insert a keyword delete the first keyword with some name, use

PFSKeyword keyw = section.InsertNewKeyword("keywordName", 1)

Public methodInsertNewSection
Insert a new section with specified name into this section object
Public methodModifyName Obsolete.
Modify the name of this section
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also