RichTextBox.SaveFile Method (Stream, RichTextBoxStreamType)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Saves the contents of a RichTextBox control to an open data stream.

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

public void SaveFile(
	Stream data,
	RichTextBoxStreamType fileType
)

Parameters

data
Type: System.IO.Stream

The data stream that contains the file to save to.

fileType
Type: System.Windows.Forms.RichTextBoxStreamType

One of the RichTextBoxStreamType values.

Exception Condition
ArgumentException

An invalid file type is specified in the fileType parameter.

IOException

An error occurs in saving the contents of the control to a file.

This version of the SaveFile method enables you to save the entire contents of the control to the data stream that is already opened. The data stream can then save the information to a file. You can use the LoadFile method to load the contents of a file into the RichTextBox.

This version of the SaveFile method also enables you to specify a data format of the information that will be sent to the Stream object.

The following code example demonstrates using the SaveFile and LoadFile methods with streams. It also demonstrates using the FileDialog.FileName, FileDialog.DefaultExt, SaveFileDialog.CreatePrompt, and SaveFileDialog.OverwritePrompt members.

This is a complete example that is ready to run when you copy it to your project.

using System;
using System.Drawing;
using System.IO;
using System.Windows.Forms;

public partial class Form1: Form
{
	internal RichTextBox RichTextBox1;
	internal Button Button1;
	internal RichTextBox RichTextBox2;
	internal Button Button2;
	internal SaveFileDialog SaveFileDialog1;

	public Form1() : base()
	{   
		this.RichTextBox1 = new RichTextBox();
		this.Button1 = new Button();
		this.RichTextBox2 = new RichTextBox();
		this.Button2 = new Button();
		this.SaveFileDialog1 = new SaveFileDialog();
		this.SuspendLayout();
		this.RichTextBox1.Location = new Point(24, 64);
		this.RichTextBox1.Name = "RichTextBox1";
		this.RichTextBox1.TabIndex = 0;
		this.RichTextBox1.Text = "Type something here.";
		this.Button1.Location = new Point(96, 16);
		this.Button1.Name = "Button1";
		this.Button1.Size = new Size(96, 24);
		this.Button1.TabIndex = 1;
		this.Button1.Text = "Save To Stream";
		this.Button1.Click += new EventHandler(Button1_Click);
		this.RichTextBox2.Location = new Point(152, 64);
		this.RichTextBox2.Name = "RichTextBox2";
		this.RichTextBox2.TabIndex = 3;
		this.RichTextBox2.Text = 
            "It will be added to the stream and appear here.";
		this.Button2.Location = new Point(104, 200);
		this.Button2.Name = "Button2";
		this.Button2.Size = new Size(88, 32);
		this.Button2.TabIndex = 4;
		this.Button2.Text = "Save Stream To File";
		this.Button2.Click += new EventHandler(Button2_Click);
		this.ClientSize = new Size(292, 266);
		this.Controls.Add(this.Button2);
		this.Controls.Add(this.RichTextBox2);
		this.Controls.Add(this.Button1);
		this.Controls.Add(this.RichTextBox1);
		this.Name = "Form1";
		this.Text = "Form1";
		this.ResumeLayout(false);
	}

	public static void Main()
	{
		Application.Run(new Form1());
	}

	// Declare a new memory stream.
	MemoryStream userInput = new MemoryStream();

	// Save the content of RichTextBox1 to the memory stream, 
	// appending a LineFeed character.  
	private void Button1_Click(Object sender, EventArgs e)
	{
		RichTextBox1.SaveFile(userInput, RichTextBoxStreamType.PlainText);
		userInput.WriteByte(13);

		// Display the entire contents of the stream,
		// by setting its position to 0, to RichTextBox2.
		userInput.Position = 0;
		RichTextBox2.LoadFile(userInput, RichTextBoxStreamType.PlainText);
	}

	// Shows the use of a SaveFileDialog to save a MemoryStream to a file.
	private void Button2_Click(Object sender, EventArgs e)
	{
		// Set the properties on SaveFileDialog1 so the user is 
		// prompted to create the file if it doesn't exist 
		// or overwrite the file if it does exist.
		SaveFileDialog1.CreatePrompt = true;
		SaveFileDialog1.OverwritePrompt = true;

		// Set the file name to myText.txt, set the type filter
		// to text files, and set the initial directory to the 
        // MyDocuments folder.
		SaveFileDialog1.FileName = "myText";
        // DefaultExt is only used when "All files" is selected from 
        // the filter box and no extension is specified by the user.
		SaveFileDialog1.DefaultExt = "txt";
        SaveFileDialog1.Filter = 
            "Text files (*.txt)|*.txt|All files (*.*)|*.*";
        SaveFileDialog1.InitialDirectory = 
            Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);

		// Call ShowDialog and check for a return value of DialogResult.OK,
		// which indicates that the file was saved. 
		DialogResult result = SaveFileDialog1.ShowDialog();
		Stream fileStream;

		if (result == DialogResult.OK)
		{
            // Open the file, copy the contents of memoryStream to fileStream,
            // and close fileStream. Set the memoryStream.Position value to 0 
            // to copy the entire stream. 
            fileStream = SaveFileDialog1.OpenFile();
			userInput.Position = 0;
			userInput.WriteTo(fileStream);
			fileStream.Close();
		}
	}
}

FileIOPermission

for creating or modifying a file. Associated enumeration: The Write value of FileIOPermissionAccess.

.NET Framework
Available since 1.1
Return to top
Show: