Arrange2DEnvelopeInput.isPartialArrangeAllowed Property

This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

Gets and sets if a partial arrange is allowed. If true, it will still create a result when there is not enough space on the envelope to fit all of the components. Components are arranged until all the available space is used up. The components that were not included in the partial arrangement are highlighted in the components list. If the envelope size increases, the arrangement recalculates to include the components that did not previously fit in the arrangement.

Syntax

# Get the value of the property.
propertyValue = arrange2DEnvelopeInput_var.isPartialArrangeAllowed

# Set the value of the property.
arrange2DEnvelopeInput_var.isPartialArrangeAllowed = propertyValue

#include <Fusion/Arrange/Arrange2DEnvelopeInput.h>

// Get the value of the property.
boolean propertyValue = arrange2DEnvelopeInput_var->isPartialArrangeAllowed();

// Set the value of the property, where value_var is a boolean.
bool returnValue = arrange2DEnvelopeInput_var->isPartialArrangeAllowed(value_var);

Property Value

Version