Export (0) Print
Expand All

TextRange.Load Method

Loads the current selection in a specified data format from a specified stream.

Namespace:  System.Windows.Documents
Assembly:  PresentationFramework (in PresentationFramework.dll)

public void Load(
	Stream stream,
	string dataFormat
)

Parameters

stream
Type: System.IO.Stream

A readable stream that contains data to load into the current selection.

dataFormat
Type: System.String

A data format to load the data as. Currently supported data formats are Rtf, Text, Xaml, and XamlPackage.

ExceptionCondition
ArgumentNullException

Occurs when stream or dataFormat is null.

ArgumentException

Occurs when the specified data format is unsupported. May also be raised if content loaded from stream does not match the specified data format.

If CanSeek is true for stream, content will be loaded from the beginning of the stream to the end of the stream. Otherwise, content will be read from the current Position to the end of the stream. When this method returns, stream is left open, and the current position within stream is undefined.

A load operation replaces the current selection with the newly loaded content.

The following example demonstrates the use of the Load method.

// This method accepts an input stream and a corresponding data format.  The method 
// will attempt to load the input stream into a TextRange selection, apply Bold formatting 
// to the selection, save the reformatted selection to an alternat stream, and return  
// the reformatted stream.  
Stream BoldFormatStream(Stream inputStream, string dataFormat)
{
    // A text container to read the stream into.
    FlowDocument workDoc = new FlowDocument();
    TextRange selection = new TextRange(workDoc.ContentStart, workDoc.ContentEnd);
    Stream outputStream = new MemoryStream();

    try
    {
        // Check for a valid data format, and then attempt to load the input stream 
        // into the current selection.  Note that CanLoad ONLY checks whether dataFormat 
        // is a currently supported data format for loading a TextRange.  It does not  
        // verify that the stream actually contains the specified format.  An exception  
        // may be raised when there is a mismatch between the specified data format and  
        // the data in the stream.  
        if (selection.CanLoad(dataFormat))
            selection.Load(inputStream, dataFormat);
    }
    catch (Exception e) { return outputStream; /* Load failure; return a null stream. */ }

    // Apply Bold formatting to the selection, if it is not empty. 
    if (!selection.IsEmpty)
        selection.ApplyPropertyValue(TextElement.FontWeightProperty, FontWeights.Bold);

    // Save the formatted selection to a stream, and return the stream. 
    if (selection.CanSave(dataFormat))
        selection.Save(outputStream, dataFormat);

    return outputStream;
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft