# Sandbox.Modals.WorkshopPublishOptions

Passed to IModalSystem.WorkshopPublish

- Kind: struct
- Namespace: `Sandbox.Modals`
- Assembly: `Sandbox.Engine`
- Modifiers: sealed

## Constructors

- [`WorkshopPublishOptions`](/api/Sandbox.Modals.WorkshopPublishOptions/.ctor)

## Properties

- [`CanSelectVisibility`](/api/Sandbox.Modals.WorkshopPublishOptions/CanSelectVisibility): Can the client select the visibility for this item
- [`Categories`](/api/Sandbox.Modals.WorkshopPublishOptions/Categories): Defined categories to show in the workshop publish modal
- [`Description`](/api/Sandbox.Modals.WorkshopPublishOptions/Description): The description of this item. The user will be able to change it.
- [`KeyValues`](/api/Sandbox.Modals.WorkshopPublishOptions/KeyValues): Keyvalues to store on the item. You can search and filter by these later.
- [`Metadata`](/api/Sandbox.Modals.WorkshopPublishOptions/Metadata): You can store metadata on the item, which is just a string. This can be read when querying items before downloading them - so it can be useful for storing extra info you want to store.
- [`OnComplete`](/api/Sandbox.Modals.WorkshopPublishOptions/OnComplete): Called when done. The ulong is the published item id. You can access it via url https://steamcommunity.com/sharedfiles/filedetails/?id=######
- [`PublishedFileId`](/api/Sandbox.Modals.WorkshopPublishOptions/PublishedFileId): If set, update this existing workshop item instead of creating a new one.
- [`StorageEntry`](/api/Sandbox.Modals.WorkshopPublishOptions/StorageEntry): The filesystem containing the files to publish
- [`Tags`](/api/Sandbox.Modals.WorkshopPublishOptions/Tags): Tags to set on the item. You can search and filter by these later.
- [`Thumbnail`](/api/Sandbox.Modals.WorkshopPublishOptions/Thumbnail): 512x512 thumbnail image, no transparency
- [`Title`](/api/Sandbox.Modals.WorkshopPublishOptions/Title): The default title of this item. The user will be able to change it.
- [`Visibility`](/api/Sandbox.Modals.WorkshopPublishOptions/Visibility): The visibility of the item

## Methods

- [`AddCategory`](/api/Sandbox.Modals.WorkshopPublishOptions/AddCategory): Adds a new category associated with the specified enum type to the collection. The user will be prompted to select one of the enum values when publishing. This will be set on the file as keyvalues[name] = enum.ToString()