Sandcastle Help File Builder Documentation
Image
This is used to get or set whether or not to copy the image to the
.\Output\[HelpFormat]\media folder if it is not referenced in a media link.
Definition
Namespace: SandcastleBuilder.Utils.ConceptualContent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
The default is false and the image will not be copied unless it is referenced in a media link. If set to true, the image will be copied even if it is not referenced. This is useful for forcing the copying of images referenced in external links which are not handled by the art reference build component.
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
C#
public bool CopyToMedia { get; set; }VB
Public Property CopyToMedia As Boolean
Get
SetC++
public:
property bool CopyToMedia {
bool get ();
void set (bool value);
}F#
member CopyToMedia : bool with get, setProperty Value
BooleanThe default is false and the image will not be copied unless it is referenced in a media link. If set to true, the image will be copied even if it is not referenced. This is useful for forcing the copying of images referenced in external links which are not handled by the art reference build component.