Loads a rich text format (RTF) or standard ASCII text file into the
RichTextBox control.
Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)
Syntax
Visual Basic (Declaration)
Public Sub LoadFile ( _
path As String _
)
Dim instance As RichTextBox
Dim path As String
instance.LoadFile(path)
public void LoadFile (
string path
)
public:
void LoadFile (
String^ path
)
public void LoadFile (
String path
)
public function LoadFile (
path : String
)
Parameters
- path
The name and location of the file to load into the control.
Exceptions
| Exception type | Condition |
|---|
IOException | An error occurred while loading the file into the control. |
ArgumentException | The file being loaded is not an RTF document. |
Remarks
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 RTF document into the control for manipulation. If you want to save the file, you can use the SaveFile method.
.gif) Note |
|---|
| With this version of the LoadFile method, if the file being loaded is not an RTF document, an exception will occur. To load a different type of file such as an ASCII text file, use the other versions of this method that accept a value from the RichTextBoxStreamType enumeration as a parameter. |
| Note |
|---|
| 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. |
Example
The following code example opens an RTF 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 assuming that it is an RTF document file. If the file is not, the example code will throw an exception. This example requires that the code is placed in a Form class that has a RichTextBox control named richTextBox1.
Public Sub LoadMyFile()
' Create an OpenFileDialog to request a file to open.
Dim openFile1 As 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) _
And (openFile1.FileName.Length > 0) Then
' Load the contents of the file into the RichTextBox.
richTextBox1.LoadFile(openFile1.FileName)
End If
End Sub
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);
}
}
public:
void LoadMyFile()
{
// Create an OpenFileDialog to request a file to open.
OpenFileDialog^ openFile1 = gcnew 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 );
}
}
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.set_DefaultExt("*.rtf");
openFile1.set_Filter("RTF Files|*.rtf");
// Determine whether the user selected a file from the OpenFileDialog.
if (openFile1.ShowDialog() ==
System.Windows.Forms.DialogResult.OK &&
openFile1.get_FileName().length() > 0) {
// Load the contents of the file into the RichTextBox.
richTextBox1.LoadFile(openFile1.get_FileName());
}
} //LoadMyFile
.NET Framework Security
Platforms
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
Version Information
.NET Framework
Supported in: 2.0, 1.1, 1.0
See Also