ImageBlock
OfficeIMO.Markdown
Image block with optional title and caption.
Inheritance
- MarkdownObject
- MarkdownBlock
- ImageBlock
Usage
Explore 2 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 2
- Method MarkdownDocument.AddImage
- Property MarkdownNativeImageBlock.Image
Constructors
public ImageBlock(string path, string? alt, string? title) #Create an image block.
Parameters
- path string
- alt string?
- title string?
public ImageBlock(string path, string? alt = null, string? title = null, OfficeLength? width = null, OfficeLength? height = null, string? linkUrl = null, string? linkTitle = null, string? linkTarget = null, string? linkRel = null, string? plainAlt = null) #Create an image block with optional size hints.
Parameters
- path string
- alt string? = null
- title string? = null
- width OfficeIMO.OfficeLength? = null
- height OfficeIMO.OfficeLength? = null
- linkUrl string? = null
- linkTitle string? = null
- linkTarget string? = null
- linkRel string? = null
- plainAlt string? = null
Inherited Methods
public void Accept(MarkdownVisitor visitor) #Parameters
- visitor MarkdownVisitor
public IEnumerable<MarkdownObject> Ancestors() #Returns
IEnumerable<MarkdownObject>public IEnumerable<MarkdownObject> AncestorsAndSelf() #Returns
IEnumerable<MarkdownObject>public IEnumerable<TObject> DescendantObjectsOfType<TObject>() #Type Parameters
- TObject
Returns
IEnumerable<TObject>public IEnumerable<MarkdownObject> Descendants() #Returns
IEnumerable<MarkdownObject>Properties
public string? LinkTitle { get; set; } #Optional hyperlink title wrapping the image.
public string? LinkTarget { get; set; } #Optional hyperlink target attribute wrapping the image in HTML.
public string? LinkRel { get; set; } #Optional hyperlink rel attribute wrapping the image in HTML.
public string? PlainAlt { get; } #Plain-text alternate text used for HTML rendering and text extraction.
public MarkdownSourceSpan? AltSourceSpan { get; } #Source span for the image alternate-text token when parsed from markdown.
public MarkdownSourceSpan? PathSourceSpan { get; } #Source span for the image path token when parsed from markdown.
public MarkdownSourceSpan? TitleSourceSpan { get; } #Source span for the image title token when parsed from markdown.
public MarkdownSourceSpan? LinkUrlSourceSpan { get; } #Source span for the wrapping link URL token when parsed from markdown.
public MarkdownSourceSpan? LinkTitleSourceSpan { get; } #Source span for the wrapping link title token when parsed from markdown.
public OfficeLength? Width { get; set; } #Optional physical display width. Unitless Markdown and HTML hints are CSS pixels.
public OfficeLength? Height { get; set; } #Optional physical display height. Unitless Markdown and HTML hints are CSS pixels.
public string? PictureFallbackPath { get; set; } #Optional fallback image URL used when rendering preserved picture sources back to HTML.
public IList<ImagePictureSource> PictureSources { get; } #HTML-only responsive picture source metadata preserved from imported <picture> elements.
Inherited Properties
public MarkdownSourceSpan? SourceSpan { get; internal set; } #public IReadOnlyList<MarkdownObject> ChildObjects { get; } #