RealDocs

UBorder::SetShowEffectWhenDisabled

function UMG Blueprint Since 4.0
#include "Components/Border.h"
Access: public Specifiers: UFUNCTIONBlueprintCallable

Description

Sets whether the border applies the standard disabled-widget visual effect when its IsEnabled state is false.

Caveats & Gotchas

  • Has no visible effect unless the border, or an ancestor widget, is actually disabled via SetIsEnabled(false).
  • The direct bShowEffectWhenDisabled UPROPERTY is deprecated as of 5.1 in favor of this setter.

Signature

UMG_API void SetShowEffectWhenDisabled(bool bInShowEffectWhenDisabled)

Parameters

Name Type Description Default
bInShowEffectWhenDisabled bool Whether to apply the standard disabled-widget visual effect (typically a desaturation) when the border is disabled.

Return Type

void

Example

Disable the desaturation effect C++
void UMyUserWidget::KeepBorderVividWhenDisabled()
{
    if (MyBorder)
    {
        MyBorder->SetShowEffectWhenDisabled(false);
    }
}

Tags

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.