Class PageSettingsBuilder

Implementation of pagesettings properties using view formatting

Inheritance

System.Object

PageSettingsBuilder

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript.DataVisualization.Builders

Assembly: Syncfusion.EJ.dll

Syntax

public class PageSettingsBuilder

Constructors

PageSettingsBuilder(DiagramProperties)

Declaration

public PageSettingsBuilder(DiagramProperties model)

Parameters

Type	Name	Description
DiagramProperties	model

Fields

diagramModel

Declaration

public DiagramProperties diagramModel

Field Value

Type	Description
DiagramProperties

Methods

AutoScrollBorder(AutoScrollBorder)

Declaration

public PageSettingsBuilder AutoScrollBorder(AutoScrollBorder autoScrollBorder)

Parameters

Type	Name	Description
AutoScrollBorder	autoScrollBorder

Returns

Type	Description
PageSettingsBuilder

MultiplePage(Boolean)

Gets or sets whether multiple pages can be created to fit all nodes and connectors

Declaration

public PageSettingsBuilder MultiplePage(bool multiplePage)

Parameters

Type	Name	Description
System.Boolean	multiplePage

Returns

Type	Description
PageSettingsBuilder	false

Examples

@{
   Html.EJ().Diagram("Diagram").Height("600px").PageSettings(ps => ps.MultiplePage(true));
}

PageBackground(String)

Gets or sets the background color of diagram pages

Declaration

public PageSettingsBuilder PageBackground(string pageBackground)

Parameters

Type	Name	Description
System.String	pageBackground

Returns

Type	Description
PageSettingsBuilder	"#ffffff"

Examples

@{
   Html.EJ().Diagram("Diagram").Height("600px").PageSettings(ps => ps.PageBackground("red"));
}

PageBorderColor(String)

Gets or sets the page border color

Declaration

public PageSettingsBuilder PageBorderColor(string pageBorder)

Parameters

Type	Name	Description
System.String	pageBorder

Returns

Type	Description
PageSettingsBuilder	"#565656"

Examples

@{
   Html.EJ().Diagram("Diagram").Height("600px").PageSettings(ps => ps.PageBorderColor("red"));
}

PageBorderWidth(Int32)

Gets or sets the border width of diagram pages

Declaration

public PageSettingsBuilder PageBorderWidth(int pageBorderWidth)

Parameters

Type	Name	Description
System.Int32	pageBorderWidth

Returns

Type	Description
PageSettingsBuilder	0

Examples

@{
   Html.EJ().Diagram("Diagram").Height("600px").PageSettings(ps => ps.PageBorderWidth(2));
}

PageHeight(Int32)

Gets or sets the height of a page

Declaration

public PageSettingsBuilder PageHeight(int pageHeight)

Parameters

Type	Name	Description
System.Int32	pageHeight

Returns

Type	Description
PageSettingsBuilder	null

Examples

@{
   Html.EJ().Diagram("Diagram").Height("600px").PageSettings(ps => ps.PageHeight(400));
}

PageMargin(Int32)

Gets or sets the page margin

Declaration

public PageSettingsBuilder PageMargin(int pageMargin)

Parameters

Type	Name	Description
System.Int32	pageMargin

Returns

Type	Description
PageSettingsBuilder	24

Examples

@{
   Html.EJ().Diagram("Diagram").Height("600px").PageSettings(ps => ps.PageMargin(30));
}

PageOrientation(PageOrientation)

Gets or sets the orientation of the page.

Declaration

public PageSettingsBuilder PageOrientation(PageOrientation pageOrientation)

Parameters

Type	Name	Description
PageOrientation	pageOrientation

Returns

Type	Description
PageSettingsBuilder	PageOrientations.Portrait

Examples

@{
   Html.EJ().Diagram("Diagram").Height("600px").PageSettings(ps => ps.PageOrientation(PageOrientation.Landscape));
}

PageWidth(Int32)

Gets or sets the height of a diagram page

Declaration

public PageSettingsBuilder PageWidth(int pageWidth)

Parameters

Type	Name	Description
System.Int32	pageWidth

Returns

Type	Description
PageSettingsBuilder	null

Examples

@{
   Html.EJ().Diagram("Diagram").Height("600px").PageSettings(ps => ps.PageWidth(400));
}

ScrollableArea(ScrollableArea)

Declaration

public PageSettingsBuilder ScrollableArea(ScrollableArea scrollableArea)

Parameters

Type	Name	Description
ScrollableArea	scrollableArea

Returns

Type	Description
PageSettingsBuilder

ScrollLimit(ScrollLimit)

Gets or sets the scrollable region of diagram.

Declaration

public PageSettingsBuilder ScrollLimit(ScrollLimit scrollLimit)

Parameters

Type	Name	Description
ScrollLimit	scrollLimit

Returns

Type	Description
PageSettingsBuilder	ScrollLimit.Infinity

Examples

@{
   Html.EJ().Diagram("Diagram").Height("600px").PageSettings(ps => ps.ScrollLimit(ScrollLimit.Diagram));
}

ShowPageBreaks(Boolean)

Gets or sets the page breaks

Declaration

public PageSettingsBuilder ShowPageBreaks(bool showPageBreak)

Parameters

Type	Name	Description
System.Boolean	showPageBreak

Returns

Type	Description
PageSettingsBuilder	false

Examples

@{
   Html.EJ().Diagram("Diagram").Height("600px").PageSettings(ps => ps.ShowPageBreaks(false));
}