Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

RichTextBox.LoadFile Method (String, RichTextBoxStreamType)

Loads a specific type of file into the RichTextBox control.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public void LoadFile(
	string path,
	RichTextBoxStreamType fileType
)

Parameters

path
Type: System.String

The name and location of the file to load into the control.

fileType
Type: System.Windows.Forms.RichTextBoxStreamType

One of the RichTextBoxStreamType values.

ExceptionCondition
IOException

An error occurred while loading the file into the control.

ArgumentException

The file being loaded is not an RTF document.

When loading a file with the LoadFile method, the contents of the file being loaded replace the entire contents of the RichTextBox control. This will cause the values of the Text and Rtf properties to change. You can use this method to load a previously created text or rich text format (RTF) document into the control for manipulation. If you want to save the file, you can use the SaveFile method.

You can use this version of the LoadFile method to specify the file type of the file being loaded. This feature enables you to load files other than RTF documents into the control.

NoteNote

The LoadFile method will not open a file until a handle is created for the RichTextBox. Ensure that the control's handle is created before calling the LoadFile method.

The following code example opens a text file into the RichTextBox control. The example uses the OpenFileDialog class to display a dialog to request the file from the user. The code then loads that file into the RichTextBox control. The example uses this version of the LoadFile method to specify that the file be opened as an ASCII text file instead of the standard rich text format. This example requires that the code is placed in a Form class that has a RichTextBox control named richTextBox1.

public void LoadMyFile()
{
   // Create an OpenFileDialog to request a file to open.
   OpenFileDialog openFile1 = new OpenFileDialog();

   // Initialize the OpenFileDialog to look for RTF files.
   openFile1.DefaultExt = "*.rtf";
   openFile1.Filter = "RTF Files|*.rtf";

   // Determine whether the user selected a file from the OpenFileDialog. 
   if(openFile1.ShowDialog() == System.Windows.Forms.DialogResult.OK &&
      openFile1.FileName.Length > 0) 
   {
      // Load the contents of the file into the RichTextBox.
      richTextBox1.LoadFile(openFile1.FileName, RichTextBoxStreamType.PlainText);
   }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Show:
© 2015 Microsoft