Class Appli.CatalogSummary

Provides an access to a catalog data without an ability to modify it, thus excluding perfomance overhead needed to convert a catalog to its editable representation.

Inheritance

object

Appli.CatalogSummary

Implements

IEquatable<Appli.CatalogSummary>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Namespace: KD.SDK2

Assembly: KD.SDK2.dll

Syntax

public class Appli.CatalogSummary : IEquatable<Appli.CatalogSummary>

Examples

// This script shows how to obtain a detailed description for one block 
// of "@K2.cat""  catalog on a named section 

var catalogSummary = appli.GetCatalogByFilename("@K2");

foreach (var section in catalogSummary.GetSections(skipHidden: true))
{
    if (section.Name == "Eléments bas < 4U")
    {
        foreach (var block in section.GetBlocks())
        {
            if (block.Name == "Bas 3U 1P")
            {
                Console.WriteLine("Description : " + block.Description);
                Console.WriteLine("Code : " + block.Code);

                var articles = block.GetArticles();

                Console.WriteLine($"{block.Name} has nb article(s): {articles.Count}");

                foreach (var article in articles)
                    Console.WriteLine($"\tDepth : {article.Depth} Height: { article.Height} Reference : {article.Reference}");

                break;
            }
        }
        break;
    }
}

Properties

Name	Description
AfterSalesCode	After sales code of the catalog.
BaseCatalogFilename	Filename of the catalog's base catalog.
BaseCatalogTime	Last write time of the catalog's base catalog (as it was at the moment when the base catalog contents was embedded inside the catalog).
Code	Code of the catalog (8 characters maximum, useful for statistics in particular).
CreationTime	Creation time of the catalog.
Currency	Code of the currency in which purchase and selling prices are defined in the catalog.
CustomInfo	Provides access to the catalogs's custom data area dedicated wholely to the application extensions.
Filename	Filename of the catalog, without path and extension (8 characters maximum).
FilenameWithPath	Filename of the catalog, with complete path and extension.
HasPurchasePrices	Indicates whether the catalog contains purchase prices.
HasSellingPrices	Indicates whether the catalog contains purchase prices.
IsBaseCatalog	Indicates whether the catalog is a base catalog.
IsComplementaryCatalog	Indicates whether the catalog is complementary.
IsValidFromDateEnabled	Indicates whether the catalog validity start date check is enabled.
IsValidTillDateEnabled	Indicates whether the catalog validity end date check is enabled.
IsVatIncluded	Indicates whether prices in the catalog include VAT.
LanguageCode	Language code of the catalog (also known as working language).
LastSaveTime	Time of the last save of the catalog.
Name	Name of the catalogue displayed in the KitchenDraw planning window (max 30 characters).
PackCode	The pack code which the catalog belongs to.
PriceConfiguration	Price configuration used in the catalog (e.g. selling prices only, or purchase and selling prices, or purchase prices only).
SubType	Subtype of the catalog.
SubTypeRank	Subtype rank of the catalog.
Type	Type of the catalog.
TypeRank	Type rank of the catalog.
Unit	Measuring unit of the catalog.
ValidFromDate	Catalog validity start date.
ValidTillDate	Catalog validity end date.
VatRate	VAT rate included in the catalog prices, if any is included, 0.0 otherwise.

Methods

Name	Description
Equals(object)	Determines whether passed object has the same type and value as this one.
ExportArticleImage(string, HandingType, bool, ViewMode, string, int, int, bool, string, int, int)	Exports thumbnail corresponding to a given article as an image file.
ExportResourceFromName(string, bool)	Exports a resource which has a given filename.
ExportResourceFromName(string, string, bool)	Exports a resource which has a given name.
GetAppliCats(bool)	Returns the list of AppliCats stored in the catalog.
GetDimensionConstraintsForKeyReference(string)	Gets the dimension constraints applied to the key reference in the catalog.
GetFamilies(bool, FetchFields)	Returns the list of families of the catalog.
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.
GetLinearArticleBlocks(LinearArticleType)	Returns the list of blocks of a particular linear type.
GetModels(bool, FetchFields)	Returns the list of models of the catalog.
GetResourceFromName(string)	Gets contents of resource with a given name as bytes.
GetResourceFromNameAsText(string, bool)	Gets contents of resource with a given name as text.
GetResourceNames()
GetSections(bool, FetchFields)	Returns the list of sections of the catalog.
GetTableLineRankFromCode(TableType, string)	Finds first occurence of a given code in a given catalog table, and returns matching row rank.
GetUrlForKeyReference(string)	Returns url of a product detail page bound to the catalog block of the key reference, if any.
LaunchAppliCat(string, string, IntPtr)	Opens an AppliCat from the catalog.
ToString()	Returns a string that represents the current object.

Operators

Name	Description
operator ==(CatalogSummary, CatalogSummary)	Determines whether two specified instances have the same value.
operator !=(CatalogSummary, CatalogSummary)	Determines whether two specified instances have different values.