Click or drag to resize

PFSKeyword Class

A PFSKeword object contains a list of parameters.

Several PFSKeywords can have equal names and different parameters.

Inheritance Hierarchy
SystemObject
  DHI.PFSPFSKeyword

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

The PFSKeyword type exposes the following members.

Properties
  NameDescription
Public propertyCount
Return the number of parameters of this KeyWord.
Public propertyItem
Get the parameter at the specified index.

Short of GetParameter(Int32)(parameterIndex+1)

Public propertyName
Name of Keyword.
Top
Methods
  NameDescription
Public methodDeleteParameter
Delete a parameter from this keyword by parameter position
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInstanceNo Obsolete.
Internal method, for testing/debugging only
Public methodGetParameter
Get the parameter number specified.
Public methodGetParametersCount
Return the number of parameters of this KeyWord.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInsertNewParameterBool
Insert a bool parameter into this keyword at the specified position.

If insertion point equals Count+1, the parameter is added to the end of the list.

Parameters at and after the insertion point move down to accomodate the new element.

This method is an O(n) operation, where n is number of parameters

Public methodInsertNewParameterClob
Insert a Clob parameter into this keyword at the specified position. The new Clob parameter is returned, and can be populated with data.

If insertion point equals Count+1, the parameter is added to the end of the list.

Parameters at and after the insertion point move down to accomodate the new element.

This method is an O(n) operation, where n is number of parameters

Public methodInsertNewParameterDouble
Insert a double parameter into this keyword at the specified position.

If insertion point equals Count+1, the parameter is added to the end of the list.

Parameters at and after the insertion point move down to accomodate the new element.

This method is an O(n) operation, where n is number of parameters

Public methodInsertNewParameterFileName
Insert a file name parameter into this keyword at the specified position.

If insertion point equals Count+1, the parameter is added to the end of the list.

Parameters at and after the insertion point move down to accomodate the new element.

This method is an O(n) operation, where n is number of parameters

Public methodInsertNewParameterInt
Insert a integer parameter into this keyword at the specified position.

If insertion point equals Count+1, the parameter is added to the end of the list.

Parameters at and after the insertion point move down to accomodate the new element.

This method is an O(n) operation, where n is number of parameters

Public methodInsertNewParameterString
Insert a string parameter into this keyword at the specified position.

If insertion point equals Count+1, the parameter is added to the end of the list.

Parameters at and after the insertion point move down to accomodate the new element.

This method is an O(n) operation, where n is number of parameters

Public methodInsertNewParameterUndefined
Insert a undefined parameter into this keyword at the specified position.

If insertion point equals Count+1, the parameter is added to the end of the list.

Parameters at and after the insertion point move down to accomodate the new element.

This method is an O(n) operation, where n is number of parameters

Public methodModifyName Obsolete.
Modify the name of this keyword
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also