markdownview — u_pbt_markdownview #

← Referencia de componentes · Índice de la guía

markdownview muestra un documento Markdown de solo lectura, con los colores del tema: títulos, listas, tablas, listas de tareas, código coloreado, imágenes. Fija el texto en is_markdown, o la ruta de un archivo en is_source; un enlace nunca navega, lanza ue_link_clicked y decide la aplicación. El HTML en bruto de un documento nunca se ejecuta.

▶ Verlo en vivo — Aplicación de demostración, mosaico Markdown viewer, con el código y esta página lado a lado.

De un vistazo #

Inicio rápido #

// Show a Markdown file : its pictures and relative links are read against its folder
uo_md.is_source = "C:\Acme\Help\guide.md"

// ... or any text the application has
uo_md.is_markdown = "# Release notes~n~n- [x] Orders~n- [ ] Invoices"

// ue_link_clicked : the viewer never navigates, the application decides where to open as_url

Propiedades #

Métodos #

Eventos #

Ejemplo #

Una ayuda en línea que abre sus enlaces #

// ue_link_clicked of uo_md : the viewer never navigates, the application decides
if Lower(Right(as_url, 3)) = ".md" and FileExists(as_url) then
	uo_md.is_source = as_url                        // another page of the help
else
	ShellExecuteW(0, "open", as_url, "", "", 1)     // a web page, a mail
end if

Editar Markdown: un codeeditor y un markdownview #

// The editor colours Markdown ; the viewer shows the page
uo_editor.is_syntax = u_pbt_codeeditor.SYNTAX_MARKDOWN
uo_editor.is_text = ls_notes
uo_md.is_markdown = ls_notes

// ue_changed of uo_editor : the whole recipe
uo_md.is_markdown = uo_editor.is_text

Una tabla de contenidos en una lista #

// Local variables
string ls_titles[], ls_anchors[]
long ll_levels[], ll_i

// One line per heading, indented by its level
for ll_i = 1 to uo_md.of_toc(/*titles*/ ls_titles, /*levels*/ ll_levels, /*anchors*/ ls_anchors)
	lb_toc.AddItem(Fill(" ", (ll_levels[ll_i] - 1) * 3) + ls_titles[ll_i])
next

// SelectionChanged of lb_toc : bring that heading to the top
uo_md.of_scroll_to(/*anchor*/ ls_anchors[index])

Buenas prácticas #

• Es un lector, no un editor: para escribir Markdown, ponga al lado un codeeditor en SYNTAX_MARKDOWN, unido por una línea en su ue_changed (ver el ejemplo).
• Los enlaces son suyos: nada se abre solo; ue_link_clicked da la dirección, ya resuelta respecto a la carpeta del archivo, y usted elige — el navegador, otro documento en el mismo componente, una pantalla de la aplicación.
• Un documento no ejecuta nada: el HTML en bruto se muestra tal como está escrito, un enlace javascript: sigue siendo texto, una imagen http:// se rechaza — un documento venido de fuera se muestra sin riesgo.
• Las imágenes: una ruta relativa se lee respecto a la carpeta del archivo; para una imagen de la Web, prefiera https://, o descárguela antes (restclient.of_download) y dé su ruta.
• Un documento grande sigue fluido: los primeros bloques aparecen enseguida, el resto en los instantes siguientes; la búsqueda, of_scroll_to y la impresión esperan a que esté completo.
• De derecha a izquierda: el documento sigue el sentido de la aplicación (listas, citas y tablas se invierten), un bloque de código sigue de izquierda a derecha.

Heredado de la base común #

Estos miembros existen en todos los componentes visuales — no son propios de este. Se detallan una sola vez, en los capítulos transversales; esta tabla solo dice dónde leerlos.

← Referencia de componentes · Índice de la guía