WindowManagerLayoutParams Class

Definition

Specifies the layout and behavior of a top-level window.

[Android.Runtime.Register("android/view/WindowManager$LayoutParams", DoNotGenerateAcw=true)]
public class WindowManagerLayoutParams : Android.Views.ViewGroup.LayoutParams, Android.OS.IParcelable, IDisposable
[<Android.Runtime.Register("android/view/WindowManager$LayoutParams", DoNotGenerateAcw=true)>]
type WindowManagerLayoutParams = class
    inherit ViewGroup.LayoutParams
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
Inheritance
WindowManagerLayoutParams
Attributes
Implements

Remarks

Android platform documentation

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Name Description
WindowManagerLayoutParams()

Initializes a new instance of WindowManagerLayoutParams.

WindowManagerLayoutParams(Int32, Int32, Int32, Int32, WindowManagerTypes, WindowManagerFlags, Format)

Creates window layout parameters with the supplied dimensions, position, window type, flags, and pixel format.

WindowManagerLayoutParams(Int32, Int32, WindowManagerTypes, WindowManagerFlags, Format)

Creates window layout parameters with the supplied dimensions, window type, flags, and pixel format.

WindowManagerLayoutParams(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

WindowManagerLayoutParams(Parcel)

Creates window layout parameters from the supplied parcel.

WindowManagerLayoutParams(WindowManagerTypes, WindowManagerFlags, Format)

Creates window layout parameters with the supplied window type, flags, and pixel format.

WindowManagerLayoutParams(WindowManagerTypes, WindowManagerFlags)

Creates window layout parameters with the supplied window type and flags.

WindowManagerLayoutParams(WindowManagerTypes)

Creates window layout parameters with the supplied window type.

Fields

Name Description
AlphaChanged
Obsolete.

Indicates that the window alpha changed when layout parameters were copied.

AnimationChanged
Obsolete.

Indicates that the window animation changed when layout parameters were copied.

BrightnessOverrideFull

Value for #screenBrightness and #buttonBrightness indicating that the screen or button backlight brightness should be set to the hightest value when this window is in front.

BrightnessOverrideNone

Default value for #screenBrightness and #buttonBrightness indicating that the brightness value is not overridden for this window and normal brightness policy should be used.

BrightnessOverrideOff

Value for #screenBrightness and #buttonBrightness indicating that the screen or button backlight brightness should be set to the lowest value when this window is in front.

DimAmountChanged
Obsolete.

Indicates that the dim amount changed when layout parameters were copied.

DisplayFlagDisableHdrConversion
Obsolete.

Indicates whether this window wants the HDR conversion is disabled.

FillParent
Obsolete.

Special value for the height or width requested by a View.

(Inherited from ViewGroup.LayoutParams)
FirstApplicationWindow

Start of window types that represent normal application windows.

FirstSubWindow

Start of types of sub-windows.

FirstSystemWindow

Start of system-specific window types.

FlagsChanged
Obsolete.

Indicates that the window flags changed when layout parameters were copied.

FormatChanged
Obsolete.

Indicates that the pixel format changed when layout parameters were copied.

LastApplicationWindow

End of types of application windows.

LastSubWindow

End of types of sub-windows.

LastSystemWindow

End of types of system windows.

LayoutChanged
Obsolete.

Indicates that the window layout changed when layout parameters were copied.

LayoutInDisplayCutoutModeAlways
Obsolete.

The window is always allowed to extend into the DisplayCutout areas on the all edges of the screen.

LayoutInDisplayCutoutModeDefault
Obsolete.

The window is allowed to extend into the DisplayCutout area, only if the DisplayCutout is fully contained within a system bar or the DisplayCutout is not deeper than 16 dp, but this depends on the OEM choice.

LayoutInDisplayCutoutModeNever
Obsolete.

The window is never allowed to overlap with the DisplayCutout area.

LayoutInDisplayCutoutModeShortEdges
Obsolete.

The window is always allowed to extend into the DisplayCutout areas on the short edges of the screen.

MatchParent

Special value for the height or width requested by a View.

(Inherited from ViewGroup.LayoutParams)
MemoryTypeChanged
Obsolete.

Indicates that the memory type changed when layout parameters were copied.

RotationAnimationChanged
Obsolete.

Indicates that the rotation animation changed when layout parameters were copied.

RotationAnimationCrossfade
Obsolete.

Value for #rotationAnimation which specifies that this window will fade in or out following a rotation.

RotationAnimationJumpcut
Obsolete.

Value for #rotationAnimation which specifies that this window will immediately disappear or appear following a rotation.

RotationAnimationRotate
Obsolete.

Value for #rotationAnimation which specifies that this window will visually rotate in or out following a rotation.

RotationAnimationSeamless
Obsolete.

Value for #rotationAnimation to specify seamless rotation mode.

ScreenBrightnessChanged
Obsolete.

Indicates that the screen brightness changed when layout parameters were copied.

ScreenOrientationChanged
Obsolete.

Indicates that the screen orientation changed when layout parameters were copied.

SoftInputModeChanged
Obsolete.

Indicates that the soft-input mode changed when layout parameters were copied.

TitleChanged
Obsolete.

Indicates that the window title changed when layout parameters were copied.

TypeChanged
Obsolete.

Indicates that the window type changed when layout parameters were copied.

WrapContent

Special value for the height or width requested by a View.

(Inherited from ViewGroup.LayoutParams)

Properties

Name Description
Alpha

An alpha value to apply to this entire window.

BlurBehindRadius

Returns the blur behind radius of the window.; Blurs the screen behind the window.

ButtonBrightness

This can be used to override the standard behavior of the button and keyboard backlights.

Class

Returns the runtime class of this Object.

(Inherited from Object)
ColorMode

Returns the color mode of the window, one of ActivityInfo#COLOR_MODE_DEFAULT, ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT or ActivityInfo#COLOR_MODE_HDR.; Set the color mode of the window.

Creator

Gets the parcelable creator for WindowManagerLayoutParams instances.

DesiredHdrHeadroom

Get the desired amount of HDR headroom as set by #setDesiredHdrHeadroom(float); Sets the desired about of HDR headroom to be used when rendering as a ratio of targetHdrPeakBrightnessInNits / targetSdrWhitePointInNits.

DimAmount

When #FLAG_DIM_BEHIND is set, this is the amount of dimming to apply.

FitInsetsIgnoringVisibility

Specifies if this window should fit the window insets no matter they are visible or not.

FitInsetsSides

Specifies sides of insets that this window should avoid overlapping during layout.

FitInsetsTypes

Specifies types of insets that this window should avoid overlapping during layout.

Flags

Various behavioral options/flags.

Format

The desired bitmap format.

FrameRateBoostOnTouchEnabled

Gets or sets whether touch input can temporarily boost the window's frame rate.

FrameRatePowerSavingsBalanced

Gets or sets whether the window balances frame rate for power savings.

Gravity

Placement of window within the screen as per Gravity.

Handle

The handle to the underlying Android instance.

(Inherited from Object)
HasKeyboardCapture

Returns whether "keyboard capture" is on.

HdrConversionEnabled

Returns whether the HDR conversion is enabled for the window; Enables/disables the HDR conversion for the window.

Height

Information about how tall the view wants to be.

(Inherited from ViewGroup.LayoutParams)
HorizontalMargin

The horizontal margin, as a percentage of the container's width, between the container and the widget.

HorizontalWeight

Indicates how much of the extra space will be allocated horizontally to the view associated with these LayoutParams.

JniIdentityHashCode

Gets the identity hash code assigned to this Java peer by the interop runtime.

(Inherited from Object)
JniManagedPeerState (Inherited from JavaObject)
JniPeerMembers

Gets the JNI peer metadata used by the .NET for Android binding runtime.

LayoutAnimationParameters

Used to animate layouts.

(Inherited from ViewGroup.LayoutParams)
LayoutInDisplayCutoutMode

Controls how the window is laid out if there is a DisplayCutout . Defaults to LAYOUT_IN_DISPLAY_CUTOUT_MODE_DEFAULT . Value is one of the following: LAYOUT_IN_DISPLAY_CUTOUT_MODE_DEFAULT LAYOUT_IN_DISPLAY_CUTOUT_MODE_SHORT_EDGES LAYOUT_IN_DISPLAY_CUTOUT_MODE_NEVER LAYOUT_IN_DISPLAY_CUTOUT_MODE_ALWAYS

MemoryType
Obsolete.

Gets or sets the memory type used for this window's surface.

PackageName

Name of the package owning this window.

PeerReference

Gets the JNI object reference for this Java peer.

(Inherited from Object)
PreferMinimalPostProcessing

Indicates whether this window wants the connected display to do minimal post processing on the produced image or video frames.

PreferredDisplayModeId

Id of the preferred display mode for the window.

PreferredRefreshRate

The preferred refresh rate for the window.

RotationAnimation

Define the exit and entry animations used on this window when the device is rotated.

ScreenBrightness

This can be used to override the user's preferred brightness of the screen.

ScreenOrientation

Specific orientation value for a window.

SoftInputMode

Desired operating mode for any soft input area.

SystemUiFlags

Gets or sets the system UI visibility flags requested by this window.

SystemUiVisibility
Obsolete.

Control the visibility of the status bar.

ThresholdClass

Gets the JNI class handle used by the .NET for Android binding runtime.

ThresholdType

Gets the managed type used by the .NET for Android binding runtime.

Title

Gets or sets the title of this window.

TitleFormatted

Sets a title for the window.

Token

Identifier for this window.

Type

The general type of window.

VerticalMargin

The vertical margin, as a percentage of the container's height, between the container and the widget.

VerticalWeight

Indicates how much of the extra space will be allocated vertically to the view associated with these LayoutParams.

Width

Information about how wide the view wants to be.

(Inherited from ViewGroup.LayoutParams)
WindowAnimations

A style resource defining the animations to use for this window.

X

X position for this window.

Y

Y position for this window.

Methods

Name Description
AreWallpaperTouchEventsEnabled()

Returns whether sending touch events to the system wallpaper (which can be provided by a third-party application) is enabled for windows that show wallpaper in background.

CanPlayMoveAnimation()

Determines whether play move animation.

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions) (Inherited from JavaObject)
CopyFrom(WindowManagerLayoutParams)

Copies layout parameters from another instance and returns a mask of the changed fields.

Debug(String)

Returns a String representation of this set of layout parameters.

DescribeContents()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Dispose()

Releases the resources held by this Java peer.

(Inherited from Object)
Dispose(Boolean)

Releases the resources held by this Java peer.

(Inherited from Object)
DisposeUnlessReferenced() (Inherited from JavaObject)
Equals(Object) (Inherited from JavaObject)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
JavaFinalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
MayUseInputMethod(WindowManagerFlags)

Given a particular set of window manager flags, determine whether such a window may be a target for an input method when it has focus.

Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
ResolveLayoutDirection(LayoutDirection)

Resolve layout parameters depending on the layout direction.

(Inherited from ViewGroup.LayoutParams)
SetBaseAttributes(TypedArray, Int32, Int32)

Extracts the layout parameters from the supplied attributes.

(Inherited from ViewGroup.LayoutParams)
SetCanPlayMoveAnimation(Boolean)

Set whether animations can be played for position changes on this window.

SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetKeyboardCaptureEnabled(Boolean)

Allows the currently focused window to capture keys before system processes system shortcuts and actions.

SetPeerReference(JniObjectReference, JniObjectReferenceOptions) (Inherited from JavaObject)
SetWallpaperTouchEventsEnabled(Boolean)

Set whether sending touch events to the system wallpaper (which can be provided by a third-party application) should be enabled for windows that show wallpaper in background.

ToArray<T>()

Creates a managed array from this Java array wrapper.

(Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime()

Unregisters this Java peer from the interop runtime.

(Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
WriteToParcel(Parcel, ParcelableWriteFlags)

Flatten this object in to a Parcel.

Explicit Interface Implementations

Name Description
IJavaPeerable.Disposed() (Inherited from JavaObject)
IJavaPeerable.Finalized() (Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock (Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32) (Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) (Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference) (Inherited from JavaObject)
IJavaPeerable.UnregisterFromRuntime()

Extension Methods

Name Description
GetJniTypeName(IJavaPeerable)

Gets the JNI name of the type of the instance self.

JavaAs<TResult>(IJavaPeerable)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
TryJavaCast<TResult>(IJavaPeerable, TResult)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Applies to