File3dmStringTable

References
public class File3dmStringTable
Provides access to document strings in the 3dm file.

Properties

Count

#Since v6.0
public int Count { get; }
Returns the number of document strings in the 3dm file.

DocumentUserTextCount

#Since v6.0
public int DocumentUserTextCount { get; }
Returns the number of Section/Entry-style key values.

Methods

Delete

#Since v6.0
public void Delete(string key)
Removes a document string from the 3dm file.
Parameters:
key (string)The key to remove.

Delete

#Since v6.0
public void Delete(string section, string entry)
Removes document strings from the 3dm file.
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 v6.0
public string[] GetEntryNames(string section)
Return list of all entry names for a given section of document strings in the 3dm file.
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 v6.0
public string GetKey(int i)
Returns a key value at a given index.
Parameters:
i (int)The index.
Returns: The key if successful.

GetSectionNames

#Since v6.0
public string[] GetSectionNames()
Returns a list of all the section names for document strings in the 3dm file.

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 v6.0
public string GetValue(int i)
Returns a string value at a given index.
Parameters:
i (int)The index at which to get the value.
Returns: The string value if successful.

GetValue

#Since v6.0
public string GetValue(string key)
Returns a string value at a key.
Parameters:
key (string)The key at which to get the value.
Returns: The string value if successful.

GetValue

#Since v6.0
public string GetValue(string section, string entry)
Returns a string value given a section and entry.
Parameters:
section (string)The section at which to get the value.
entry (string)The entry to search for.
Returns: The string value if successful.

SetString

#Since v6.0
public string SetString(string key, string value)
Adds or sets a document string in the 3dm file.
Parameters:
key (string)The key.
value (string)The entry value.
Returns: The previous value if successful.

SetString

#Since v6.0
public string SetString(string section, string entry, string value)
Adds or sets a document string in the 3dm file.
Parameters:
section (string)The section.
entry (string)The entry name.
value (string)The entry value.
Returns: The previous value if successful.