Class SetTextLayoutModeOverrideCommandParameters

Namespace

WebDriverBiDi.Emulation

Assembly

WebDriverBiDi.dll

Provides parameters for the emulation.setTextLayoutModeOverride command.

public class SetTextLayoutModeOverrideCommandParameters : CommandParameters<SetTextLayoutModeOverrideCommandResult>

Inheritance

object

CommandParameters

CommandParameters<SetTextLayoutModeOverrideCommandResult>

SetTextLayoutModeOverrideCommandParameters

Inherited Members

CommandParameters<SetTextLayoutModeOverrideCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SetTextLayoutModeOverrideCommandParameters()

Initializes a new instance of the SetTextLayoutModeOverrideCommandParameters class.

public SetTextLayoutModeOverrideCommandParameters()

Properties

Contexts

Gets the browsing contexts for which to set the emulated text layout mode.

[JsonIgnore]
public List<string> Contexts { get; }

Property Value

List<string>

Remarks

The protocol requires this property, when present, to contain at least one entry. An empty list therefore means "not specified": the property is omitted from the JSON payload entirely, and an empty array is never sent. Add entries to the list to scope the command.

The two scopes are mutually exclusive: a command that names both browsing contexts and user contexts is rejected by the remote end with an invalid argument error. Scope the command one way or the other.

MethodName

Gets the method name of the command.

[JsonIgnore]
public override string MethodName { get; }

Property Value

string

ResetTextLayoutModeOverride

Gets a pre-initialized instance of SetTextLayoutModeOverrideCommandParameters with the TextLayoutMode property set to null to clear any existing text layout mode override. Returns a new instance on each access to allow for modification of the properties without affecting other uses. Functionally equivalent to using the parameterless constructor, but provided as a named property to make the intent of clearing the override more explicit in code that uses this property.

public static SetTextLayoutModeOverrideCommandParameters ResetTextLayoutModeOverride { get; }

Property Value

SetTextLayoutModeOverrideCommandParameters

TextLayoutMode

Gets or sets the text layout mode to emulate. When null, clears the emulated text layout mode.

[JsonPropertyName("textLayoutMode")]
public TextLayoutMode? TextLayoutMode { get; set; }

Property Value

TextLayoutMode?

UserContexts

Gets the user contexts for which to set the emulated text layout mode.

[JsonIgnore]
public List<string> UserContexts { get; }

Property Value

List<string>

Remarks

The protocol requires this property, when present, to contain at least one entry. An empty list therefore means "not specified": the property is omitted from the JSON payload entirely, and an empty array is never sent. Add entries to the list to scope the command.

The two scopes are mutually exclusive: a command that names both browsing contexts and user contexts is rejected by the remote end with an invalid argument error. Scope the command one way or the other.