ApplyCharacterStyle メソッド

指定した文字スタイルを指定したスパンのランに適用します。

シンタックス

Visual Basic

'宣言
 
Public Sub ApplyCharacterStyle( _
   ByVal span As DocumentSpan, _
   ByVal styleId As String, _
   ByRef error As String, _
   Optional ByVal clearExistingCharacterSettings As Boolean _
) 

C#

public void ApplyCharacterStyle( 
   DocumentSpan span,
   string styleId,
   out string error,
   bool clearExistingCharacterSettings
)

パラメータ

span

変更に適用するドキュメント スパン。

styleId

ルート ノードの DocumentRootNode.Styles コレクションまたはドキュメントの AvailableStyles コレクションの文字スタイルの ID。後者の場合、スタイルが利用可能なスタイルからルート ノードのスタイル コレクションにコピーされます。

error

指定した ID を持つ文字スタイルが存在しないか、その他のエラーが発生する場合、これはエラー メッセージに設定されます。

clearExistingCharacterSettings

ランの明示的な RunNode.Settings をクリアするかどうかを指定します。ランが以前に書式を適用された場合、その Settings が設定されます。ランの Settings プロパティは RunNode.StyleId のスタイル設定より優先があります。このパラメーターに True を渡すと、指定したスタイルの設定が RunNode の設定によってオーバーライドされないことを確認します。

解説

ApplyCharacterStyle メソッドは、指定したスパンに含まれているランの RunNode.StyleId プロパティを設定します。ランの部分が指定したドキュメント スパンと交差する場合、ランが必要に応じて分割されます。このように、スパンに含まれているコンテンツのみが指定した文字スタイルに適用されます。

注: スパンのランにスタイル ID が以前に設定される場合、それが指定した styleId にリセットされます。