ClearCharacterStyle Method

Resets RunNode.StyleId to null on runs in the specified span.

Syntax

Visual Basic

'Declaration
 
Public Sub ClearCharacterStyle( _
   ByVal span As DocumentSpan, _
   ByRef error As String, _
   Optional ByVal alsoClearExistingCharacterSettings As Boolean _
) 

C#

public void ClearCharacterStyle( 
   DocumentSpan span,
   out string error,
   bool alsoClearExistingCharacterSettings
)

Parameters

span

Document span to apply the changes to.

error

If an error occurs this will be set to the error message.

alsoClearExistingCharacterSettings

Specifies whether to clear runs' explicit RunNode.Settings also. If a run has had some character formatting applied to it previously then its Settings would have been set accordingly. Specifying True for this parameter clears those settings as well.

Remarks

ClearCharacterStyle method sets the RunNode.StyleId property of runs that are contained by the specified span to null. If a run partially spans the specified document span then the run will be broken up as necessary so that only the content that's contained by the span is affected by this operation.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2