StringTable

References
public sealed class StringTable
Collection of document user data strings

Properties

Count

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

Document

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

DocumentDataCount

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

DocumentUserTextCount

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

Methods

Delete

#Since v5.0
public void Delete(string key)
Parameters:
key (string)

Delete

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

GetEntryNames

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

GetKey

#Since v5.0
public string GetKey(int i)
Parameters:
i (int)

GetSectionNames

#Since v5.0
public string[] GetSectionNames()
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.

Returns: An array of section names. This can be empty, but not null.

GetValue

#Since v5.0
public string GetValue(int i)
Parameters:
i (int)

GetValue

#Since v5.0
public string GetValue(string key)
Parameters:
key (string)

GetValue

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

SetString

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

SetString

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