File Operation in Windows Forms Syntax Editor

18 Nov 201815 minutes to read

Supports all file operations like create new, open, or save.

Load file

The LoadFile function loads the content of any desired file into the Syntax Editor. The function is explained as follows.

Function	Description
LoadFile	Shows the Open File dialog to the user and opens the selected file.

NOTE

The character encoding for the text can also be specified while loading the file.

C#

// Displays the Open File dialog.

this.editControl1.LoadFile();

// Loads the content of the specified file.

this.editControl1.LoadFile("Temp.txt", Encoding.ASCII);

VB.NET

' Displays the Open File dialog.

Me.editControl1.LoadFile()

' Loads the content of the specified file. 

Me.editControl1.LoadFile("Temp.txt", Encoding.ASCII)

Retrieve loaded file path

The name of the currently loaded stream in the Edit Control can be get or set by using the FileOpened property.

C#

// Gets or sets the name of the stream that is currently loaded in the Syntax Editor.

this.editControl1.FileOpened = new FileStream("Temp.txt", FileMode.Create);

VB.NET

' Gets or sets the name of the stream that is currently loaded in the Syntax Editor.

Me.editControl1.FileOpened = New FileStream("Temp.txt", FileMode.Create)

Retrieve loaded file name

By using the FileName property, you can get or set the name of the currently loaded file in the Syntax Editor.

C#

// Specifies the name of the file loaded in the Syntax Editor.

this.editControl1.FileName = "Temp.txt";

VB.NET

' Specifies the name of the file loaded in the Syntax Editor.

Me.editControl1.FileName = "Temp.txt"

Load from stream

Content of the Syntax Editor can also be loaded to a particular stream by using the specified encoding and line end style by using the LoadStream function.

C#

// Loads the content of the specified stream into the Syntax Editor.

this.editControl1.LoadStream(streamName);

// Loads the specified stream and configuration.

this.editControl1.LoadStream(streamName, config);

VB.NET

' Loads the content of the specified stream into the Syntax Editor.

Me.editControl1.LoadStream(streamName)

' Loads the specified stream and configuration.

Me.editControl1.LoadStream(streamName, config)

Drop file to load contents

The Syntax Editor provides a complete support for dropped the dragged files by using the DropAllFiles and FileExtension properties. The properties are explained as follows.

Properties	Description
DropAllFiles	Specifies whether all files can be dropped onto Syntax Editor or not. If set to `false`, files with extensions contained in FileExtensions can only be dropped.
FileExtensions	Specifies the extensions of files that can be dropped to the Syntax Editor.

C#

// Drops all files onto Syntax Editor.

this.editControl1.DropAllFiles = true;

// Specifies the file extensions of files that can be dropped onto Syntax Editor. 

this.editControl1.FileExtensions = new string[] {".cs", ".sql", ".vb", ".xml"};

VB.NET

' Drops all files onto Syntax Editor.

Me.editControl1.DropAllFiles = True

' Specifies the file extensions of files that can be dropped onto Syntax Editor.

Me.editControl1.FileExtensions = New String() {".cs", ".sql", ".vb", ".xml"}

The following properties can be used to insert the text based on conditions described as follows.

Properties	Description
AllowDrop	Specifies whether the drag and drop operations are allowed for the control or not.
InsertDroppedFileIntoText	Specifies whether the outer file dragged and dropped onto the Syntax Editor should be inserted into the current content. When this property is set to `false`, the current file is closed and the dropped outer file is opened.
ShowFileDropNotification	Specifies whether the notification message is to be displayed when the outer file is dragged and dropped onto the Syntax Editor.

C#

//To set the Syntax Editor that allows to Drag and Dropping files

this.editControl1.AllowDrop = true; 

// Specifies whether the outer file dragged and dropped onto the Syntax Editor should be inserted into the current content.

this.editControl1.InsertDroppedFileIntoText = true;

// To hide the notification message displayed when the outer file is dragged and dropped onto the Syntax Editor.

this.editControl1.ShowFileDropNotification = false;

VB.NET

'To set the EditControl that allows to Drag and Dropping files

Me.editControl1.AllowDrop = True

‘Specifies whether the outer file dragged and dropped onto the Syntax Editor should be inserted into the current content.

Me.editControl1.InsertDroppedFileIntoText = True

' To hide the notification message displayed when the outer file is dragged and dropped onto the Syntax Editor.

Me.editControl1.ShowFileDropNotification = False

File modification

By using the FileModified and IsModified properties of the Syntax Editor, you can ensure whether the content of the file was modified or not.

C#

Console.WriteLine(this.editControl1.IsModified);

VB.NET

Console.WriteLine(Me.editControl1.IsModified)

Create file

The New and NewFile functions helps to create a new stream or file. It optionally allows you to set the language to be used by specifying the appropriate configuration settings.

C#

// Creates a new stream with default configuration settings.

this.editControl.New();

// Creates a new file with default configuration settings.

this.editControl.NewFile();

// Creates a new stream with specified configuration settings.

this.editControl.New(ConfigLanguage language);


// Creates a new file with specified configuration settings.

this.editControl.NewFile(IConfigLanguage language);

VB.NET

' Creates a new file.

Me.editControl1.NewFile()

Me.editControl1.[New]()

' **config** is Configuration Settings file of type IConfigLanguage.

Me.editControl1.NewFile(config)

Me.editControl1.[New](config)

Discard changes

The changes made to the content of the Syntax Editor can be discarded by using the FlushChanges function.

C#

// Saves changes made to the contents of the Syntax Editor into the current stream.

this.editControl1.FlushChanges();

VB.NET

' Saves changes made to the contents of the Syntax Editor into the current stream.

Me.editControl1.FlushChanges()

Save file

The following functions helps to save a file in the Syntax Editor.

Functions	Description
SaveFile	Saves the content of the Syntax Editor to a specified file.
Save	Invokes the Save File dialog box and lets you save the contents of the Syntax Editor to the specified file.
SaveAs	Opens SaveAs dialog and prompts you to enter the name of the file.
SaveModified	Saves the file only if it was modified and prompts for the filename if needed. This is especially useful when the application is about to be closed or a new file is being loaded into the Syntax Editor.

C#

// Saves the contents of the file.

this.editControl1.SaveFile("Temp.txt", Encoding.Unicode, Syncfusion.IO.NewLineStyle.Control);

// Displays the Save File dialog.

this.editControl1.Save();

// Displays the SaveAs dialog. 

this.editControl1.SaveAs();

// Saves the contents of the file after modification, when a new file is loaded, or when a file is closed.

this.editControl1.SaveModified();

VB.NET

' Saves the contents of the file.

Me.editControl1.SaveFile("Temp.txt", Encoding.Unicode, Syncfusion.IO.NewLineStyle.Control)

' Displays the Save File dialog.

Me.editControl1.Save()

' Displays the SaveAs dialog. 

Me.editControl1.SaveAs()

' Saves the contents of the file after modification, when a new file is loaded, or when a file is closed.

Me.editControl1.SaveModified()

Save as stream

Content of the Syntax Editor can also be saved to a particular stream by using the specified encoding and line end style by using the SaveStream function.

C#

// Saves content to the specified stream using specified encoding and line end style.

this.editControl1.SaveStream(System.IO.Stream.Null , Encoding.BigEndianUnicode, Syncfusion.IO.NewLineStyle.Mac);

VB.NET

' Saves content to the specified stream using specified encoding and line end style.

Me.editControl1.SaveStream(System.IO.Stream.Null , Encoding.BigEndianUnicode, Syncfusion.IO.NewLineStyle.Mac)

The changes made to the content of the Syntax Editor can be saved or discarded. The SaveOnClose property specifies whether the default Save Changes prompt should be displayed on closing the Syntax Editor or not.

C#

// Disables the default Save Changes prompt that appears when the form hosting Syntax Editor containing unsaved contents is closed.

this.editControl1.SaveOnClose = false;

VB.NET

' Disables the default Save Changes prompt that appears when the form hosting Syntax Editor containing unsaved contents is closed.

Me.editControl1.SaveOnClose = False

Auto Save file on close

When the SaveOnClose property is set to false, the default Save Changes prompt does not appear. The user should perform some custom Save routine in the Closing event handler of the host form to save the unsaved contents in the Syntax Editor. If not, they will be lost.

C#

private void Form1_Closing(object sender, System.ComponentModel.CancelEventArgs e)
{

   if (this.editControl1.SaveOnClose == false)
   {

      if (this.editControl1.SaveModified() == true)

          // Perform custom Save routine or show custom Save Changes dialog or set Cancel to False.                       
          e.Cancel = false;

      else

          e.Cancel = true;

    }

}

VB.NET

Private Sub Form1_Closing(ByVal sender As Object, ByVal e As System.ComponentModel.CancelEventArgs) Handles MyBase.Closing

If Me.editControl1.SaveOnClose = False Then

If Me.editControl1.SaveModified() = True Then

       ' Perform custom Save routine or show custom Save Changes dialog or set Cancel to False.

       e.Cancel = False

       Else

       e.Cancel = True

       End If

End If

End Sub

When the SaveOnClose property is set to true, the default Save Changes prompt appears on closing the Syntax Editor without saving the contents. Click Yes to save the changes, No to discard the changes, or Cancel to close the Save Changes prompt.

The above task can be further customized by handling the Closing event of Syntax Editor. The Closing event is triggered just before a file or stream is closed in the Syntax Editor.

C#

private void editControl1_Closing(object sender, Syncfusion.Windows.Forms.Edit.StreamCloseEventArgs e)
{

// Cancel the file or stream closing action.

e.Action = SaveChangesAction.Cancel;

// Close the file or stream without saving the unsaved contents, the changes will be lost forever.

e.Action = SaveChangesAction.Discard;

// Silently saves the unsaved contents to the currently open file or stream.

// If the contents have not been saved to a file or stream as yet, the Save Changes prompt is displayed.

e.Action = SaveChangesAction.Save;

// Displays the default Save Changes prompt if there are unsaved contents when the file or stream is closed.

e.Action = SaveChangesAction.ShowDialog;

}

VB.NET

Private Sub editControl1_Closing(ByVal sender As Object, ByVal e As Syncfusion.Windows.Forms.Edit.StreamCloseEventArgs) Handles EditControl1.StreamClose

' Cancel the file or stream closing action.

e.Action = SaveChangesAction.Cancel

' Close the file or stream without saving the unsaved contents, the changes will be lost forever.

e.Action = SaveChangesAction.Discard

' Silently saves the unsaved contents to the currently open file or stream.

' If the contents have not been saved to a file or stream as yet, the Save Changes prompt is displayed

e.Action = SaveChangesAction.Save

' Displays the default Save Changes prompt if there are unsaved contents when the file or stream is closed.

e.Action = SaveChangesAction.ShowDialog

End Sub

NOTE

The default value of e.Action is SaveChangesAction.ShowDialog.

Insert file

The following functions helps to insert a file in the Syntax Editor.

Functions	Parameters	Description
InsertFile	-	Shows Insert file dialog and inserts the selected file.
InsertFile	public void InsertFile(string filePath)	Inserts a file by using file path.

C#

//Displays the Insert dialog box

this.editControl1.InsertFile();

//Insert a file using file path

this.editControl1.InsertFile(@"..\\..\\Form2.cs");

VB.NET

'Displays the Insert dialog box

Me.editControl1.InsertFile

'Insert a file using file path

Me.editControl1.InsertFile(@"..\\..\\Form2.cs")

Close file

The Close function helps to close the currently opened file or stream and displays the Syntax Editor in the read-only mode until a new file or stream is opened. The function is explained as follows.

Function	Description
Close	Closes the stream and makes the control readonly.

C#

// Closes the currently open file or stream in the Syntax Editor. 

this.editControl1.Close();

VB.NET

' Closes the currently open file or stream in the Syntax Editor. 

Me.editControl1.Close()