ScrollMode

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.ScrollMode
Namespace	Electron2D
Kind	enum
Category	UI and Text

Overview

Describes how a Electron2D.ScrollContainer exposes scrolling on one axis.

Syntax

public enum Electron2D.ScrollMode : System.IComparable, System.IConvertible, System.IFormattable, System.ISpanFormattable

Godot 4.7 C# profile compatibility

Profile: Electron2D 0.1.0 2D
Status: Supported / Parity verified
Out of profile: no
Godot reference: ScrollContainer.ScrollMode

Axis scroll policy values for disabled, auto and scrollbar presentation modes.

Remarks

The 0.1.0 Preview runtime uses these values for scroll offset policy. Visual scrollbar controls are outside this container task.

Since

This enum is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.ScrollContainer.HorizontalScrollMode
• Electron2D.ScrollContainer.VerticalScrollMode

Members

Member	Kind	Summary
Auto	Enum value	Allows scrolling when content is larger than the container.
Disabled	Enum value	Disables scrolling on the axis.
MaximizeFirst	Enum value	Prefers maximizing the content area before showing scroll affordances.
Reserve	Enum value	Reserves room for future visual scrollbar presentation.
ShowAlways	Enum value	Keeps the axis available even when content currently fits.
ShowNever	Enum value	Keeps the axis hidden while preserving programmatic policy state.

Member Details

Auto

Kind: Enum value

public const Electron2D.ScrollMode Auto

Summary

Allows scrolling when content is larger than the container.

Remarks

This is the default mode for both scroll axes.

Since

This enum value is available since Electron2D 0.1.0 Preview.

Disabled

Kind: Enum value

public const Electron2D.ScrollMode Disabled

Summary

Disables scrolling on the axis.

Remarks

The scroll offset is clamped to zero while this mode is active.

Since

This enum value is available since Electron2D 0.1.0 Preview.

MaximizeFirst

Kind: Enum value

public const Electron2D.ScrollMode MaximizeFirst

Summary

Prefers maximizing the content area before showing scroll affordances.

Remarks

This value is preserved for API compatibility with future visual scrollbars.

Since

This enum value is available since Electron2D 0.1.0 Preview.

Reserve

Kind: Enum value

public const Electron2D.ScrollMode Reserve

Summary

Reserves room for future visual scrollbar presentation.

Remarks

The preview implementation keeps layout stable without creating scrollbar nodes.

Since

This enum value is available since Electron2D 0.1.0 Preview.

ShowAlways

Kind: Enum value

public const Electron2D.ScrollMode ShowAlways

Summary

Keeps the axis available even when content currently fits.

Remarks

Visual scrollbar presentation is not part of the 0.1.0 Preview baseline.

Since

This enum value is available since Electron2D 0.1.0 Preview.

ShowNever

Kind: Enum value

public const Electron2D.ScrollMode ShowNever

Summary

Keeps the axis hidden while preserving programmatic policy state.

Remarks

This mode does not create a public scrollbar control.

Since

This enum value is available since Electron2D 0.1.0 Preview.