OfficeTextFeatureSettings
OfficeIMO.Drawing
Immutable OpenType feature selections used by the shared text-shaping contract.
Inheritance
- object
- OfficeTextFeatureSettings
Remarks
Tags use the four-character OpenType representation. A value of zero disables a feature; positive values enable it or select an alternate. Features absent from the collection retain the shaping engine's script defaults.
Usage
Explore 6 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 4
- Property OfficeDrawingText.FeatureSettings
- Method OfficeTextFeatureSettings.With
- Property OfficeTextFeatureSettings.Default
- Property OfficeTextShapingRequest.FeatureSettings
Accepted by parameters 2
Constructors
public OfficeTextFeatureSettings() #Creates an empty feature selection.
public OfficeTextFeatureSettings(IEnumerable<KeyValuePair<string, int>>? features) #Creates an immutable snapshot of feature tag values.
Parameters
- features System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, int>>?
Methods
public bool Equals(OfficeTextFeatureSettings? other) #Indicates whether the current object is equal to another object of the same type.
Parameters
- other OfficeIMO.Drawing.OfficeTextFeatureSettings?
- An object to compare with this object.
Returns
bool true if the current object is equal to the other parameter; otherwise, false.public override bool Equals(object? obj) #Determines whether the specified object is equal to the current object.
Parameters
- obj object?
- The object to compare with the current object.
Returns
bool true if the specified object is equal to the current object; otherwise, false.public override int GetHashCode() #Serves as the default hash function.
Returns
int A hash code for the current object.public bool TryGetValue(string tag, out int value) #Returns the explicit value for a feature tag.
Parameters
- tag string
- value int
Returns
boolpublic OfficeTextFeatureSettings With(string tag, int value) #Returns a new immutable selection with one feature value added or replaced.
Parameters
- tag string
- value int
Returns
OfficeTextFeatureSettingsInherited Methods
Properties
public static OfficeTextFeatureSettings Default { get; } #No explicit feature overrides.
public IReadOnlyDictionary<string, int> Features { get; } #Explicit OpenType feature values keyed by four-character tag.
public bool IsDefault { get; } #True when no feature differs from the shaping engine's defaults.