TextRange.Save メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
現在の選択範囲を、指定したデータ形式で指定したストリームに保存します。
オーバーロード
| 名前 | 説明 |
|---|---|
| Save(Stream, String) |
現在の選択範囲を、指定したデータ形式で指定したストリームに保存します。 |
| Save(Stream, String, Boolean) |
カスタム TextElement オブジェクトを保持するオプションを使用して、現在の選択範囲を指定したデータ形式で指定したストリームに保存します。 |
Save(Stream, String)
現在の選択範囲を、指定したデータ形式で指定したストリームに保存します。
public:
void Save(System::IO::Stream ^ stream, System::String ^ dataFormat);
public void Save(System.IO.Stream stream, string dataFormat);
member this.Save : System.IO.Stream * string -> unit
Public Sub Save (stream As Stream, dataFormat As String)
パラメーター
- stream
- Stream
現在の選択範囲を保存する空の書き込み可能なストリーム。
- dataFormat
- String
現在の選択範囲を保存するデータ形式。 現在サポートされているデータ形式は、 Rtf、 Text、 Xaml、および XamlPackageです。
例外
stream または dataFormat が null。
例
Save メソッドの使用例を次に示します。
// 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;
}
' 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.
Private Function BoldFormatStream(ByVal inputStream As Stream, ByVal dataFormat As String) As Stream
' A text container to read the stream into.
Dim workDoc As New FlowDocument()
Dim selection As New TextRange(workDoc.ContentStart, workDoc.ContentEnd)
Dim outputStream As Stream = 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) Then
selection.Load(inputStream, dataFormat)
End If
Catch e As Exception ' Load failure return a null stream.
Return outputStream
End Try
' Apply Bold formatting to the selection, if it is not empty.
If Not selection.IsEmpty Then
selection.ApplyPropertyValue(TextElement.FontWeightProperty, FontWeights.Bold)
End If
' Save the formatted selection to a stream, and return the stream.
If selection.CanSave(dataFormat) Then
selection.Save(outputStream, dataFormat)
End If
Return outputStream
End Function
注釈
このメソッドが戻ると、 stream は開いたままになり、 stream 内の現在の位置は未定義になります。
保存操作の一環として、現在の選択範囲のコンテンツを、 dataFormatで指定されたデータ形式に変換できます。
こちらもご覧ください
適用対象
Save(Stream, String, Boolean)
カスタム TextElement オブジェクトを保持するオプションを使用して、現在の選択範囲を指定したデータ形式で指定したストリームに保存します。
public:
void Save(System::IO::Stream ^ stream, System::String ^ dataFormat, bool preserveTextElements);
public void Save(System.IO.Stream stream, string dataFormat, bool preserveTextElements);
member this.Save : System.IO.Stream * string * bool -> unit
Public Sub Save (stream As Stream, dataFormat As String, preserveTextElements As Boolean)
パラメーター
- stream
- Stream
現在の選択範囲を保存する空の書き込み可能なストリーム。
- dataFormat
- String
現在の選択範囲を保存するデータ形式。 現在サポートされているデータ形式は、 Rtf、 Text、 Xaml、および XamlPackageです。
- preserveTextElements
- Boolean
true カスタム TextElement オブジェクトを保持する場合は "。それ以外の場合は false。
例外
streamまたはdataFormatがnullされたときに発生します。
指定したデータ形式がサポートされていない場合に発生します。
streamから読み込まれたコンテンツが指定したデータ形式と一致しない場合にも発生する可能性があります。
注釈
preserveTextElementsがfalseされると、カスタム TextElement オブジェクトは既知のTextElement型として保存されます。 たとえば、TextElementから継承する Heading1 というカスタム Paragraphを作成するとします。
preserveTextElementsを false に設定してこのメソッドを呼び出すと、Heading1が保存されるときにParagraphがTextRangeに変換されます。
preserveTextElementsを true に設定してこのメソッドを呼び出すと、Heading1は変換されずに保存されます。 カスタム テキスト要素を保持するには、 dataFormat を DataFormats.Xaml に設定する必要があります。
Save(Stream, String, Boolean) は、.NET Framework バージョン 3.5 で導入されています。 詳細については、「 バージョンと依存関係」を参照してください。