StringTable

References
public sealed class StringTable
Collection of document user data strings

Properties

Count

#Since v5.0
The number of user data strings in the current document.
public int Count { get; }

Document

#Since v5.0
Document that owns this object table.
public RhinoDoc Document { get; }

DocumentDataCount

#Since v6.0
public int DocumentDataCount { get; }

DocumentUserTextCount

#Since v6.0
public int DocumentUserTextCount { get; }

Methods

Delete

#Since v5.0
public void Delete(
key
)

Delete

#Since v5.0
Removes user data strings from the document.
public void Delete(
section,
name of section to delete. If null, all sections will be deleted.
entry
name of entry to delete. If null, all entries will be deleted for a given section.
)

GetEntryNames

#Since v5.0
Return list of all entry names for a given section of user data strings in the document.
public string[] GetEntryNames(
section
The section from which to retrieve section names.
)
An array of section names. This can be empty, but not null.

GetKey

#Since v5.0
public string GetKey(
i
)

GetSectionNames

#Since v5.0
Returns a list of all the section names for user data strings in the document.

By default a section name is a key that is prefixed with a string separated by a backslash.

public string[] GetSectionNames()
An array of section names. This can be empty, but not null.

GetValue

#Since v5.0
public string GetValue(
i
)

GetValue

#Since v5.0
public string GetValue(
key
)

GetValue

#Since v5.0
Gets a user data string from the document.
public string GetValue(
section,
The section at which to get the value.
entry
The entry to search for.
)
The user data.

SetString

#Since v5.0
Adds or sets a user data string to the document.
public string SetString(
key,
The key.
value
The entry value.
)
The previous value if successful and a previous value existed.

SetString

#Since v5.0
Adds or sets a user data string to the document.
public string SetString(
section,
The section.
entry,
The entry name.
value
The entry value.
)
The previous value if successful and a previous value existed.