SiteBase.CS_CreateEditIcon Method (CategoryId, DocumentId, DocumentId, String, Boolean, SiteBase.CS

SiteBaseCS_CreateEditIcon Method (CategoryId, DocumentId, DocumentId, String, Boolean, SiteBaseCS_EditIconTypes)

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Returns HTML code for displaying an edit icon in web view.

Namespace: ContentStudio.Site
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

public string CS_CreateEditIcon(
	CategoryId categoryId,
	DocumentId documentId,
	DocumentId parentDocumentId,
	string documentName,
	bool doPermissionCheck,
	SiteBaseCS_EditIconTypes iconType
)

Public Function CS_CreateEditIcon ( 
	categoryId As CategoryId,
	documentId As DocumentId,
	parentDocumentId As DocumentId,
	documentName As String,
	doPermissionCheck As Boolean,
	iconType As SiteBaseCS_EditIconTypes
) As String

Parameters

categoryId: Type: ContentStudio.DocumentCategoryId
The category ID for the document.
documentId: Type: ContentStudio.DocumentDocumentId
The document ID
parentDocumentId: Type: ContentStudio.DocumentDocumentId
The documents parent ID (used for menu icons only).
documentName: Type: SystemString
The name of the document
doPermissionCheck: Type: SystemBoolean
Set to true if web view permissions should be checked for this icon, otherwise false. The recommended value is false due to performance issues.
iconType: Type: ContentStudio.SiteSiteBaseCS_EditIconTypes
Which type of edit icon that should be displayed.

Return Value

Type: String
Returns HTML code for displaying an edit icon in web view. If the user is not in web-view the function will return an empty string

Reference

SiteBase Class

CS_CreateEditIcon Overload

ContentStudio.Site Namespace