KitchenDraw SDK 2
Show / Hide Table of Contents

Class Scene.Heading

Represents a heading, which can be considered as a table of the pricing view that accumulates similar scene objects and generates a sub-total.

Inheritance
object
Scene.Heading
Implements
IEquatable<Scene.Heading>
Inherited Members
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetType()
object.MemberwiseClone()
Namespace: KD.SDK2
Assembly: KD.SDK2.dll
Syntax
public class Scene.Heading : IEquatable<Scene.Heading>
Remarks

It is possible to apply rebate in percentae or in value to the sub-total corresponding to a heading. Heading may have a Scene.Generic associated with it, which allows to objects belonging to the heading to share default finishes configuration.

Constructors

Name Description
Heading(Scene, int)

Constructs and instance of Heading class providing access to a heading with given rank.

Properties

Name Description
DiscountPercents

Discount in percentage granted for the heading.

DiscountValue

Discount in value granted for the heading.

Generic

Generic corresponding to this heading (for furniture headings only, may be null otherwise).

Name

Name of the heading.

Objects

Objects belonging to the heading (top-level objects and their child objects altogether).

ObjectsBySupplier

Objects belonging to the heading and given suppluer (top-level objects and their child objects altogether).

ObjectsFactorized

Objects belonging to the heading (top-level objects and their child objects altogether). Identical objects are automatically factorized (listed once).

Rank

Rank of the heading in the scene (zero-based).

TopLevelObjects

Top-level objects belonging to the heading (components and hosted objects are not listed).

TopLevelObjectsFactorized

Top-level objects belonging to the heading (components and hosted objects are not listed). Identical objects are automatically factorized (listed once).

Topic

Topic identifier associated with the heading (example: 0 for the "Kitchen and bathroom" topic).

TopicType

Topic type associated with the heading.

VatCoefficient1

Normal VAT coefficient associated with the heading (example: 1.20 for a VAT rate of 20.0%).

VatCoefficient2

Reduced VAT coefficient associated with the heading.

VatCoefficient3

"Alternate" VAT coefficient associated with the heading.

Methods

Name Description
Equals(Heading)

Determines whether passed instance has the same value as this one.

Equals(object)

Determines whether passed object has the same type and value as this one.

GetHashCode()

Provides a numeric value that is used to identify an object in hash-based algorithms.

GetInfo(int)

Gets a value from arbitrary datafield specified by the infoType parameter.

GetInfoAsBool(int)

Gets a value from arbitrary datafield specified by the infoType parameter.

GetInfoAsDouble(int)

Gets a value from arbitrary datafield specified by the infoType parameter.

GetInfoAsInt(int)

Gets a value from arbitrary datafield specified by the infoType parameter.

SetInfo(int, bool)

Writes the value to the arbitrary datafield specified by the infoType parameter.

SetInfo(int, double)

Writes the value to the arbitrary datafield specified by the infoType parameter.

SetInfo(int, int)

Writes the value to the arbitrary datafield specified by the infoType parameter.

SetInfo(int, string)

Writes the value to the arbitrary datafield specified by the infoType parameter.

ToString()

Returns a string that represents the current object.

TrySetInfo(int, bool)

Writes the value to the arbitrary datafield specified by the infoType parameter.

TrySetInfo(int, double)

Writes the value to the arbitrary datafield specified by the infoType parameter.

TrySetInfo(int, int)

Writes the value to the arbitrary datafield specified by the infoType parameter.

TrySetInfo(int, string)

Writes the value to the arbitrary datafield specified by the infoType parameter.

Operators

Name Description
operator ==(Heading, Heading)

Determines whether two specified instances have the same value.

operator !=(Heading, Heading)

Determines whether two specified instances have different values.

In this article
Back to top Generated by DocFX