TextLog

Public Class

Used for collecting text data

Inheritance Hierarchy

System.Object
Rhino.FileIO.TextLog

Namespace: Rhino.FileIO

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class TextLog : IDisposable

The TextLog type exposes the following members.

Constructors

Name

Description

---

Public Method

TextLog.

Creates a text log that stores all text in memory. Use ToString on this version of the TextLog to get the text that we written

---

Public Method

TextLog(IntPtr)

Initializes a new instance of the TextLog class

---

Public Method

TextLog(String)

Creates a text log that writes all text to a file. If no filename is provided, then text is written to StdOut

---

Properties

Name

Description

---

Public Property

IndentSize

0: one tab per indent. >0: number of spaces per indent

---

Methods

Name

Description

---

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

---

Protected Method

Dispose(Boolean)

For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

(Overrides Object.Finalize..)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method
Static Member
NewCommandLine

Returns a reference to a TextLog that prints to the Rhino command line. Each new command line reference holds its own indents.

---

Public Method
Code Example

PopIndent

Decrease the indentation level

---

Public Method
Code Example

Print(String)

Send text to the text log

---

Public Method

Print(String, Object)

Send formatted text to the text log

---

Public Method

Print(String, Object, Object)

Send formatted text to the text log

---

Public Method

PrintWrappedText

Send text wrapped at a set line length

---

Public Method
Code Example

PushIndent

Increase the indentation level

---

Public Method

ToString

If the TextLog was constructed using the empty constructor, then the text information is stored in a runtime string. The contents of this string is retrieved using ToString for this case

(Overrides Object.ToString..)

---