Show All

propertySettingReason Method

Returns an Integer that specifies the numeric value of the reason for the property setting. See property setting reasons for more information on the numeric values.

expression.propertySettingReason(strPropertyName)

expression    Required. An expression that returns one of the objects in the Applies To list.

strPropertyName    Required. A String that represents a style attribute. You can get a list of style attributes from the CSS Reference on the Microsoft Developer Network (MSDN) Web site.

Remarks

Use the propertySettingReason method if if you need to implement a formatting command that requires various style properties or where you need to know the current style properties for a range of elements. For example, if you have a text range that contains <p><span style=”font-size: small”>foo</span><font size=3>bar</font></p> and you want to set the font-size style attribute, you may want to check to see if the propertySettingReason method returns a value of 1 (ssrInConflict), which would indicate that there are conflicting property settings within the range. In that case, you may not want to apply yet another font size style setting to the range.

Example

The following example inserts text into the active document, and then if the background-color attribute isn't specified, it applies a background color to the body of the document.

    Dim objStyleState As IFPStyleState
Dim objRange As IHTMLTxtRange

Set objRange = ActiveDocument.Selection.createRange
Set objStyleState = ActiveDocument.createStyleState

With objStyleState
    If .propertySettingReason("background-color") = 0 Then
        .gather objRange
        .setProperty "background-color", vbBlue
        .Apply
    End If
End With