File3dmStringTable

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

Properties

Count

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

DocumentUserTextCount

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

Methods

Delete

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

Delete

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

GetSectionNames

#Since v6.0
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.

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

GetValue

#Since v6.0
Returns a string value at a given index.
public string GetValue(
i
The index at which to get the value.
)
The string value if successful.

GetValue

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

GetValue

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

SetString

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

SetString

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