Skip to main content

GetClassType

Returns a type of the ApiRGBColor class.

Syntax​

expression.GetClassType();

expression - A variable that represents a ApiRGBColor class.

Parameters​

This method doesn't have any parameters.

Returns​

"rgbColor"

Example​

Check what category a custom color value belongs to in a document.

// How do I find out the type of a custom color used for a shape fill in a document?

// Confirm the color category before reusing a custom color object in a document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let rgbColor = Api.CreateRGBColor(255, 111, 61);
let gs1 = Api.CreateGradientStop(Api.RGB(255, 213, 191), 0);
let gs2 = Api.CreateGradientStop(rgbColor, 100000);
let fill = Api.CreateRadialGradientFill([gs1, gs2]);
let stroke = Api.CreateStroke(0, Api.CreateNoFill());
let drawing = Api.CreateShape("rect", 5930900, 395605, fill, stroke);
paragraph.AddDrawing(drawing);
let classType = rgbColor.GetClassType();
paragraph = Api.CreateParagraph();
paragraph.AddText("Class Type = " + classType);
doc.Push(paragraph);